Convert image trace attributes to TS

Author: camdecoster

src/traces/image/attributes.js src/traces/image/attributes.tssrc/traces/image/attributes.js renamed to src/traces/image/attributes.ts

@@ -1,21 +1,26 @@
 'use strict';
 
-var baseAttrs = require('../../plots/attributes');
-var zorder = require('../scatter/attributes').zorder;
+import type { AttributeMap, AttrsToType } from '../../types/lib/attributes';
+
+const baseAttrs = require('../../plots/attributes');
+const { zorder } = require('../scatter/attributes');
 const { hovertemplateAttrs, templatefallbackAttrs } = require('../../plots/template_attributes');
-var extendFlat = require('../../lib/extend').extendFlat;
-var colormodel = require('./constants').colormodel;
+const extendFlat = require('../../lib/extend').extendFlat;
+const { colormodel } = require('./constants');
 
-var cm = ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla'];
-var zminDesc = [];
-var zmaxDesc = [];
-for (var i = 0; i < cm.length; i++) {
-    var cr = colormodel[cm[i]];
+const cm = ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla'] as const;
+const zminDesc: string[] = [];
+const zmaxDesc: string[] = [];
+for (let i = 0; i < cm.length; i++) {
+    const cr = colormodel[cm[i]];
     zminDesc.push('For the `' + cm[i] + '` colormodel, it is [' + (cr.zminDflt || cr.min).join(', ') + '].');
     zmaxDesc.push('For the `' + cm[i] + '` colormodel, it is [' + (cr.zmaxDflt || cr.max).join(', ') + '].');
 }
 
-module.exports = extendFlat({
+/**
+ * @generates ImageTrace
+ */
+const attributes = {
     source: {
         valType: 'string',
         editType: 'calc',
@@ -43,7 +48,7 @@ module.exports = extendFlat({
     },
     zsmooth: {
         valType: 'enumerated',
-        values: ['fast', false],
+        values: ['fast', false] as const,
         dflt: false,
         editType: 'plot',
         description: [
@@ -133,5 +138,9 @@ module.exports = extendFlat({
     hovertemplate: hovertemplateAttrs({}, { keys: ['z', 'color', 'colormodel'] }),
     hovertemplatefallback: templatefallbackAttrs(),
 
-    zorder: zorder
-});
+    zorder
+} as const satisfies AttributeMap;
+
+export type ImageTraceAttributes = AttrsToType<typeof attributes>;
+
+export default attributes;

src/traces/image/defaults.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var Lib = require('../../lib');
-var attributes = require('./attributes');
+var attributes = require('./attributes').default;
 var constants = require('./constants');
 var dataUri = require('../../snapshot/helpers').IMAGE_URL_PREFIX;
 

src/traces/image/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
 module.exports = {
-    attributes: require('./attributes'),
+    attributes: require('./attributes').default,
     supplyDefaults: require('./defaults'),
     calc: require('./calc'),
     plot: require('./plot'),

src/types/generated/index.d.ts

@@ -3,4 +3,5 @@
  * Run `npm run gen:types` to regenerate.
  */
 
+export type { ImageTrace } from './traces/image';
 export type { ModeBar } from './components/modebar';

src/types/generated/traces/image.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Generated from src/traces/image/attributes.ts.
+ * Do not edit by hand — run `npm run gen:types`.
+ */
+
+import type { Datum, TypedArray } from '../../lib/common';
+
+export interface ImageTrace {
+    source?: string;
+    z?: Datum[] | TypedArray;
+    colormodel?: 'rgb' | 'rgba' | 'rgba256' | 'hsl' | 'hsla';
+    zsmooth?: false | 'fast';
+    zmin?: unknown[];
+    zmax?: unknown[];
+    x0?: any;
+    y0?: any;
+    dx?: number;
+    dy?: number;
+    text?: Datum[] | TypedArray;
+    hovertext?: Datum[] | TypedArray;
+    hoverinfo?: any;
+    hovertemplate?: any;
+    hovertemplatefallback?: any;
+    zorder?: any;
+}