@supernova-studio/client 1.2.2 → 1.3.0

package/dist/index.d.mts

@@ -92432,6 +92432,130 @@ declare class ExportersEndpoint {
             replacementExporterId?: string | undefined;
         };
     }>;
+    deprecate(workspaceId: string, exporterId: string, body: DTOExporterDeprecationInput): Promise<{
+        description: string;
+        isPrivate: boolean;
+        id: string;
+        name: string;
+        source: "upload" | "git";
+        version: string;
+        exporterType: "code" | "documentation";
+        isDefaultDocumentationExporter: boolean;
+        configurationProperties: {
+            key: string;
+            type: "string" | "number" | "boolean" | "image" | "enum" | "color" | "typography" | "component" | "componentProperties" | "tokenProperties" | "tokenType";
+            category: string;
+            label: string;
+            values?: string[] | null | undefined;
+            default?: string | number | boolean | null | undefined;
+            description?: string | null | undefined;
+            inputType?: "code" | "plain" | undefined;
+            isMultiline?: boolean | null | undefined;
+        }[];
+        customBlocks: {
+            key: string;
+            properties: {
+                key: string;
+                type: "string" | "number" | "boolean" | "image" | "enum" | "color" | "typography" | "component" | "componentProperties" | "tokenProperties" | "tokenType";
+                label: string;
+                values?: string[] | null | undefined;
+                default?: string | number | boolean | null | undefined;
+                description?: string | null | undefined;
+                inputType?: "code" | "plain" | undefined;
+                isMultiline?: boolean | null | undefined;
+            }[];
+            category?: string | undefined;
+            description?: string | undefined;
+            title?: string | undefined;
+            iconURL?: string | undefined;
+            mode?: NonNullable<"array" | "block"> | undefined;
+        }[];
+        blockVariants: Record<string, {
+            key: string;
+            name: string;
+            description?: string | undefined;
+            isDefault?: boolean | undefined;
+            thumbnailURL?: string | undefined;
+        }[]>;
+        tags: string[];
+        usesLocale: boolean;
+        usesBrands: boolean;
+        usesThemes: boolean;
+        isDeprecated: boolean;
+        properties?: ({
+            options: Record<string, {
+                description: string;
+                label: string;
+            }>;
+            type: "Enum";
+            description: string;
+            title: string;
+            key: string;
+            default: string;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Boolean";
+            description: string;
+            title: string;
+            key: string;
+            default: boolean;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "String";
+            description: string;
+            title: string;
+            key: string;
+            default: string;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Number";
+            description: string;
+            title: string;
+            key: string;
+            default: number;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Array";
+            description: string;
+            title: string;
+            key: string;
+            default: string[];
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Object";
+            description: string;
+            title: string;
+            key: string;
+            default: Record<string, string>;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+            allowedKeys?: {
+                options: string[];
+                type: string;
+            } | undefined;
+            allowedValues?: {
+                type: string;
+            } | undefined;
+        })[] | undefined;
+        organization?: string | undefined;
+        iconURL?: string | undefined;
+        homepage?: string | undefined;
+        packageId?: string | undefined;
+        author?: string | undefined;
+        readme?: string | undefined;
+        routingVersion?: string | undefined;
+        gitProvider?: string | undefined;
+        gitUrl?: string | undefined;
+        gitBranch?: string | undefined;
+        gitDirectory?: string | undefined;
+        deprecationNote?: string | undefined;
+        replacementExporterId?: string | undefined;
+    }>;
 }
 
 declare class ExporterJobsEndpoint {

package/dist/index.d.ts

@@ -92432,6 +92432,130 @@ declare class ExportersEndpoint {
             replacementExporterId?: string | undefined;
         };
     }>;
+    deprecate(workspaceId: string, exporterId: string, body: DTOExporterDeprecationInput): Promise<{
+        description: string;
+        isPrivate: boolean;
+        id: string;
+        name: string;
+        source: "upload" | "git";
+        version: string;
+        exporterType: "code" | "documentation";
+        isDefaultDocumentationExporter: boolean;
+        configurationProperties: {
+            key: string;
+            type: "string" | "number" | "boolean" | "image" | "enum" | "color" | "typography" | "component" | "componentProperties" | "tokenProperties" | "tokenType";
+            category: string;
+            label: string;
+            values?: string[] | null | undefined;
+            default?: string | number | boolean | null | undefined;
+            description?: string | null | undefined;
+            inputType?: "code" | "plain" | undefined;
+            isMultiline?: boolean | null | undefined;
+        }[];
+        customBlocks: {
+            key: string;
+            properties: {
+                key: string;
+                type: "string" | "number" | "boolean" | "image" | "enum" | "color" | "typography" | "component" | "componentProperties" | "tokenProperties" | "tokenType";
+                label: string;
+                values?: string[] | null | undefined;
+                default?: string | number | boolean | null | undefined;
+                description?: string | null | undefined;
+                inputType?: "code" | "plain" | undefined;
+                isMultiline?: boolean | null | undefined;
+            }[];
+            category?: string | undefined;
+            description?: string | undefined;
+            title?: string | undefined;
+            iconURL?: string | undefined;
+            mode?: NonNullable<"array" | "block"> | undefined;
+        }[];
+        blockVariants: Record<string, {
+            key: string;
+            name: string;
+            description?: string | undefined;
+            isDefault?: boolean | undefined;
+            thumbnailURL?: string | undefined;
+        }[]>;
+        tags: string[];
+        usesLocale: boolean;
+        usesBrands: boolean;
+        usesThemes: boolean;
+        isDeprecated: boolean;
+        properties?: ({
+            options: Record<string, {
+                description: string;
+                label: string;
+            }>;
+            type: "Enum";
+            description: string;
+            title: string;
+            key: string;
+            default: string;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Boolean";
+            description: string;
+            title: string;
+            key: string;
+            default: boolean;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "String";
+            description: string;
+            title: string;
+            key: string;
+            default: string;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Number";
+            description: string;
+            title: string;
+            key: string;
+            default: number;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Array";
+            description: string;
+            title: string;
+            key: string;
+            default: string[];
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+        } | {
+            type: "Object";
+            description: string;
+            title: string;
+            key: string;
+            default: Record<string, string>;
+            category?: string | undefined;
+            dependsOn?: Record<string, boolean> | undefined;
+            allowedKeys?: {
+                options: string[];
+                type: string;
+            } | undefined;
+            allowedValues?: {
+                type: string;
+            } | undefined;
+        })[] | undefined;
+        organization?: string | undefined;
+        iconURL?: string | undefined;
+        homepage?: string | undefined;
+        packageId?: string | undefined;
+        author?: string | undefined;
+        readme?: string | undefined;
+        routingVersion?: string | undefined;
+        gitProvider?: string | undefined;
+        gitUrl?: string | undefined;
+        gitBranch?: string | undefined;
+        gitDirectory?: string | undefined;
+        deprecationNote?: string | undefined;
+        replacementExporterId?: string | undefined;
+    }>;
 }
 
 declare class ExporterJobsEndpoint {

package/dist/index.js

@@ -131,6 +131,7 @@ var _slugify = require('@sindresorhus/slugify'); var _slugify2 = _interopRequire
 
 
 
+
 
 
 var _ipcidr = require('ip-cidr'); var _ipcidr2 = _interopRequireDefault(_ipcidr);
@@ -575,7 +576,10 @@ var Exporter = _zod.z.object({
   details: ExporterDetails,
   exporterType: nullishToOptional(ExporterType).default("code"),
   storagePath: nullishToOptional(_zod.z.string()).default(""),
-  properties: nullishToOptional(ExporterPropertyDefinition.array())
+  properties: nullishToOptional(ExporterPropertyDefinition.array()),
+  isDeprecated: _zod.z.boolean().default(false),
+  deprecationNote: nullishToOptional(_zod.z.string()),
+  replacementExporterId: nullishToOptional(_zod.z.string())
 });
 var AssetDynamoRecord = _zod.z.object({
   path: _zod.z.string(),
@@ -3302,6 +3306,12 @@ var DataSourceVersion = _zod.z.object({
 function zeroNumberByDefault2() {
   return _zod.z.number().nullish().transform((v) => _nullishCoalesce(v, () => ( 0)));
 }
+var FigmaFile = _zod.z.object({
+  id: _zod.z.string(),
+  name: _zod.z.string(),
+  lastModifiedAt: _zod.z.date(),
+  thumbnailUrl: _zod.z.string().optional()
+});
 var ImportJobState = _zod.z.enum(["PendingInput", "Queued", "InProgress", "Failed", "Success"]);
 var ImportJobOperation = _zod.z.enum(["Check", "Import"]);
 var ImportJob = Entity.extend({
@@ -4369,6 +4379,7 @@ var Pipeline = _zod.z.object({
   themePersistentId: _zod.z.string().optional(),
   themePersistentIds: _zod.z.string().array().optional(),
   exporterPropertyValues: ExporterPropertyValueMap.optional(),
+  isExporterDeprecated: _zod.z.boolean(),
   // Destinations
   ...ExportDestinationsMap.shape
 });
@@ -5254,8 +5265,7 @@ function pipelineToDto(pipeline) {
     exporterPropertyValues: pipeline.exporterPropertyValues,
     webhookUrl: pipeline.webhookUrl,
     latestJobs: [],
-    // TODO Brady: replace with an actual value
-    isExporterDeprecated: false
+    isExporterDeprecated: pipeline.isExporterDeprecated
   };
 }
 
@@ -7696,6 +7706,16 @@ var ExportersEndpoint = class {
   get(workspaceId, exporterId) {
     return this.requestExecutor.json(`/codegen/workspaces/${workspaceId}/exporters/${exporterId}`, DTOExporterResponse);
   }
+  deprecate(workspaceId, exporterId, body) {
+    return this.requestExecutor.json(
+      `/codegen/workspaces/${workspaceId}/exporters/${exporterId}/deprecation`,
+      DTOExporter,
+      {
+        body,
+        method: "PUT"
+      }
+    );
+  }
 };
 
 // src/api/endpoints/codegen/jobs.ts