@supernova-studio/model 0.46.7 → 0.46.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.46.7",
+  "version": "0.46.9",
   "description": "Supernova Data Models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/dsm/elements/theme.ts

@@ -1,9 +1,9 @@
 import { z } from "zod";
-import { DesignTokenOrigin, DesignTokenOriginPart, DesignTokenTypedData } from "./tokens";
-import { DesignTokenType } from "./raw-element";
-import { DesignElementBase, DesignElementBrandedPart } from "./base";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import { OmitStrict } from "../../utils";
+import { DesignElementBase, DesignElementBrandedPart } from "./base";
+import { DesignTokenType } from "./raw-element";
+import { DesignTokenOrigin, DesignTokenOriginPart, DesignTokenTypedData } from "./tokens";
 
 //
 // Overrides
@@ -59,6 +59,7 @@ export const ThemeOrigin = z.object({
 export const Theme = DesignElementBase.extend(DesignElementBrandedPart.shape).extend({
   origin: ThemeOrigin.optional(),
   overrides: z.array(ThemeOverride),
+  codeName: z.string(),
 });
 
 export type Theme = z.infer<typeof Theme>;

package/src/export/export-destinations.ts

@@ -0,0 +1,75 @@
+import { z } from "zod";
+import { PublishedDocEnvironment } from "../dsm";
+
+const BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
+const BITBUCKET_MAX_LENGTH = 64;
+
+export const ExporterDestinationDocs = z.object({
+  environment: PublishedDocEnvironment,
+});
+
+export const ExporterDestinationS3 = z.object({});
+
+export const ExporterDestinationGithub = z.object({
+  connectionId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.coerce.string(),
+});
+
+export const ExporterDestinationAzure = z.object({
+  connectionId: z.string(),
+  organizationId: z.string(),
+  projectId: z.string(),
+  repositoryId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.coerce.string(),
+  // url: z.string(),
+});
+
+export const ExporterDestinationGitlab = z.object({
+  connectionId: z.string(),
+  projectId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.coerce.string(),
+  // url: z.string(),
+});
+
+export const ExporterDestinationBitbucket = z.object({
+  connectionId: z.string(),
+  workspaceSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  projectKey: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  repoSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.string(),
+  // url: z.string(),
+});
+
+export const ExportDestinationsMap = z.object({
+  webhookUrl: z.string().optional(),
+  destinationSnDocs: ExporterDestinationDocs.optional(),
+  destinationS3: ExporterDestinationS3.optional(),
+  destinationGithub: ExporterDestinationGithub.optional(),
+  destinationAzure: ExporterDestinationAzure.optional(),
+  destinationGitlab: ExporterDestinationGitlab.optional(),
+  destinationBitbucket: ExporterDestinationBitbucket.optional(),
+});
+
+export type ExporterDestinationDocs = z.infer<typeof ExporterDestinationDocs>;
+export type ExporterDestinationS3 = z.infer<typeof ExporterDestinationS3>;
+export type ExporterDestinationGithub = z.infer<typeof ExporterDestinationGithub>;
+export type ExporterDestinationAzure = z.infer<typeof ExporterDestinationAzure>;
+export type ExporterDestinationGitlab = z.infer<typeof ExporterDestinationGitlab>;
+export type ExporterDestinationBitbucket = z.infer<typeof ExporterDestinationBitbucket>;
+export type ExportDestinationsMap = z.infer<typeof ExportDestinationsMap>;

package/src/export/export-jobs.ts

@@ -0,0 +1,110 @@
+import { z } from "zod";
+import { PublishedDocEnvironment } from "../dsm";
+import { DbCreateInputOmit, DbUpdate } from "../helpers";
+import { ExportDestinationsMap } from "./export-destinations";
+
+//
+// Enums
+//
+
+export const ExportJobDestinationType = z.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
+export const ExportJobStatus = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
+export const ExportJobLogEntryType = z.enum(["success", "info", "warning", "error", "user"]);
+
+export type ExportJobDestinationType = z.infer<typeof ExportJobDestinationType>;
+export type ExportJobStatus = z.infer<typeof ExportJobStatus>;
+export type ExportJobLogEntryType = z.infer<typeof ExportJobLogEntryType>;
+
+//
+// Results
+//
+
+export const ExportJobLogEntry = z.object({
+  id: z.string().optional(),
+  time: z.coerce.date(),
+  type: ExportJobLogEntryType,
+  message: z.string(),
+});
+
+export const ExportJobPullRequestDestinationResult = z.object({
+  pullRequestUrl: z.string(),
+});
+
+export const ExportJobS3DestinationResult = z.object({
+  bucket: z.string(),
+  urlPrefix: z.string().optional(),
+  path: z.string(),
+  files: z.array(z.string()),
+});
+
+export const ExportJobDocsDestinationResult = z.object({
+  url: z.string(),
+});
+
+export const ExportJobResult = z.object({
+  error: z.string().optional(),
+  s3: ExportJobS3DestinationResult.optional(),
+  github: ExportJobPullRequestDestinationResult.optional(),
+  azure: ExportJobPullRequestDestinationResult.optional(),
+  gitlab: ExportJobPullRequestDestinationResult.optional(),
+  bitbucket: ExportJobPullRequestDestinationResult.optional(),
+  sndocs: ExportJobDocsDestinationResult.optional(),
+});
+
+export type ExportJobLogEntry = z.infer<typeof ExportJobLogEntry>;
+export type ExportJobPullRequestDestinationResult = z.infer<typeof ExportJobPullRequestDestinationResult>;
+export type ExportJobS3DestinationResult = z.infer<typeof ExportJobS3DestinationResult>;
+export type ExportJobDocsDestinationResult = z.infer<typeof ExportJobDocsDestinationResult>;
+export type ExportJobResult = z.infer<typeof ExportJobResult>;
+
+//
+// Job
+//
+
+export const ExportJob = z.object({
+  id: z.string(),
+  createdAt: z.date(),
+  finishedAt: z.date().optional(),
+  designSystemId: z.string(),
+  designSystemVersionId: z.string(),
+  workspaceId: z.string(),
+  scheduleId: z.string().nullish(),
+  exporterId: z.string(),
+  brandId: z.string().optional(),
+  themeId: z.string().optional(),
+  estimatedExecutionTime: z.number().optional(),
+  status: ExportJobStatus,
+  result: ExportJobResult.optional(),
+  createdByUserId: z.string().optional(),
+
+  // Destinations
+  ...ExportDestinationsMap.shape,
+});
+
+export type ExportJob = z.infer<typeof ExportJob>;
+
+export type CreateExportJob = DbCreateInputOmit<ExportJob>;
+export type UpdateExportJob = Pick<DbUpdate<ExportJob>, "id" | "status" | "result" | "finishedAt">;
+
+//
+// Support
+//
+
+export const ExportJobFindByFilter = ExportJob.pick({
+  exporterId: true,
+  designSystemVersionId: true,
+  destinations: true,
+  createdByUserId: true,
+  status: true,
+  scheduleId: true,
+  designSystemId: true,
+  themeId: true,
+  brandId: true,
+})
+  .extend({
+    destinations: z.array(ExportJobDestinationType),
+    docsEnvironment: PublishedDocEnvironment,
+  })
+  .partial();
+
+export type ExportJobFindByFilter = z.infer<typeof ExportJobFindByFilter>;

package/src/export/export-runner/export-context.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+import { ExporterPropertyValue, PublishedDocEnvironment } from "../../dsm";
+
+export const ExportJobDocumentationContext = z.object({
+  isSingleVersionDocs: z.boolean(),
+  versionSlug: z.string(),
+  environment: PublishedDocEnvironment,
+});
+
+export const ExportJobContext = z.object({
+  apiUrl: z.string(),
+  accessToken: z.string(),
+  designSystemId: z.string(),
+  designSystemVersionId: z.string(),
+  brandId: z.string().optional(),
+  exporterPackageUrl: z.string(),
+  exporterPropertyValues: ExporterPropertyValue.array(),
+  documentation: ExportJobDocumentationContext.optional(),
+});
+
+export type ExportJobDocumentationContext = z.infer<typeof ExportJobDocumentationContext>;
+export type ExportJobContext = z.infer<typeof ExportJobContext>;

package/src/export/export-runner/exporter-payload.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+export const ExporterFunctionPayload = z.object({
+  exportJobId: z.string(),
+  exportContextId: z.string(),
+  designSystemId: z.string(),
+});
+
+export type ExporterFunctionPayload = z.infer<typeof ExporterFunctionPayload>;

package/src/export/export-runner/index.ts

@@ -0,0 +1,2 @@
+export * from "./export-context";
+export * from "./exporter-payload";

package/src/export/export-schedule.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import { ExportDestinationsMap } from "./export-destinations";
+
+export const ExporterScheduleEventType = z.enum(["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]);
+
+export const ExporterSchedule = z.object({
+  id: z.string(),
+
+  name: z.string(),
+  eventType: ExporterScheduleEventType,
+  isEnabled: z.boolean(),
+
+  workspaceId: z.string(),
+  designSystemId: z.string(),
+  exporterId: z.string(),
+
+  brandId: z.string().optional(),
+  themeId: z.string().optional(),
+
+  // Destinations
+  ...ExportDestinationsMap.shape,
+});
+
+export type ExporterScheduleEventType = z.infer<typeof ExporterScheduleEventType>;
+export type ExporterSchedule = z.infer<typeof ExporterSchedule>;

package/src/{codegen → export}/index.ts

@@ -1,3 +1,4 @@
+export * from "./export-runner";
 export * from "./export-destinations";
 export * from "./export-jobs";
 export * from "./export-schedule";

package/src/index.ts

@@ -1,10 +1,10 @@
 export * from "./auth";
 export * from "./billing";
-export * from "./codegen";
 export * from "./common";
 export * from "./custom-domains";
 export * from "./docs-server";
 export * from "./dsm";
+export * from "./export";
 export * from "./feature-flags";
 export * from "./helpers";
 export * from "./integrations";

package/src/utils/index.ts

@@ -1,5 +1,6 @@
 export * from "./common";
 export * from "./content-loader-instruction";
 export * from "./errors";
+export * from "./naming";
 export * from "./slugify";
 export * from "./validation";

package/src/utils/naming.ts

@@ -0,0 +1,73 @@
+// this has been ported from the Dart cloud app
+export function getCodenameFromText(name: string): string {
+  // Turn all characters with diacritics into their simple form (ě -> e, ö -> o, etc.)
+  let codeName = removeDiacritics(name);
+
+  // Remove all invalid characters
+  codeName = codeName.replace(/[^a-zA-Z0-9$_ ]+/g, "");
+  // Remove all starting numbers
+  codeName = codeName.replace(/^[0-9 ]+/g, "");
+  // Change to CamelCase
+  codeName = toCamelCase(codeName.toLowerCase());
+  // Remove all spaces
+  codeName = codeName.replace(/ /g, "");
+
+  if (codeName) {
+    // Lowercase the first letter
+    codeName = codeName.charAt(0).toLowerCase() + codeName.slice(1);
+  }
+
+  return codeName;
+}
+
+function toCamelCase(str: string): string {
+  return str.replace(/(?:^\w|[A-Z]|\b\w|\s+)/g, function (match, index) {
+    if (+match === 0) return ""; // or if (/\s+/.test(match)) for white spaces
+    return index === 0 ? match.toLowerCase() : match.toUpperCase();
+  });
+}
+
+function removeDiacritics(str: string): string {
+  const diacriticsMap = [
+    {
+      base: "A",
+      letters:
+        /[\u0041\u24B6\uFF21\u00C0\u00C1\u00C2\u1EA6\u1EA4\u1EAA\u1EA8\u00C3\u0100\u0102\u1EB0\u1EAE\u1EB4\u1EB2\u0226\u01E0\u00C4\u01DE\u1EA2\u00C5\u01FA\u01CD\u0200\u0202\u1EA0\u1EAC\u1EB6\u1E00\u0104\u023A\u2C6F]/g,
+    },
+    { base: "AA", letters: /[\uA732]/g },
+    { base: "AE", letters: /[\u00C6\u01FC\u01E2]/g },
+    { base: "AO", letters: /[\uA734]/g },
+    { base: "AU", letters: /[\uA736]/g },
+    { base: "AV", letters: /[\uA738\uA73A]/g },
+    { base: "AY", letters: /[\uA73C]/g },
+    {
+      base: "B",
+      letters: /[\u0042\u24B7\uFF22\u1E02\u1E04\u1E06\u0243\u0182\u0181]/g,
+    },
+    {
+      base: "C",
+      letters: /[\u0043\u24B8\uFF23\u0106\u0108\u010A\u010C\u00C7\u1E08\u0187\u023B\uA73E]/g,
+    },
+    /* ... */
+    {
+      base: "Z",
+      letters: /[\u005A\u24CF\uFF3A\u0179\u1E90\u017B\u017D\u1E92\u1E94\u01B5\u0224\u2C7F\u2C6B\uA762]/g,
+    },
+    {
+      base: "a",
+      letters:
+        /[\u0061\u24D0\uFF41\u1E9A\u00E0\u00E1\u00E2\u1EA7\u1EA5\u1EAB\u1EA9\u00E3\u0101\u0103\u1EB1\u1EAF\u1EB5\u1EB3\u0227\u01E1\u00E4\u01DF\u1EA3\u00E5\u01FB\u01CE\u0201\u0203\u1EA1\u1EAD\u1EB7\u1E01\u0105\u2C65\u0250]/g,
+    },
+    /* ... */
+    {
+      base: "z",
+      letters: /[\u007A\u24E9\uFF5A\u017A\u1E91\u017C\u017E\u1E93\u1E95\u01B6\u0225\u0240\u2C6C\uA763]/g,
+    },
+  ];
+
+  diacriticsMap.forEach(diacritic => {
+    str = str.replace(diacritic.letters, diacritic.base);
+  });
+
+  return str;
+}

package/src/codegen/export-destinations.ts

@@ -1,54 +0,0 @@
-import { PublishedDocEnvironment } from "../dsm";
-import { z } from "zod";
-
-export const ExporterDestinationSnDocs = z.object({
-  environment: PublishedDocEnvironment,
-});
-
-export const ExporterDestinationS3 = z.object({});
-
-export const ExporterDestinationGithub = z.object({
-  connectionId: z.string(),
-  url: z.string(),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-});
-
-export const ExporterDestinationAzure = z.object({
-  connectionId: z.string(),
-  organizationId: z.string(),
-  projectId: z.string(),
-  repositoryId: z.string(),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-  url: z.string(),
-});
-
-export const ExporterDestinationGitlab = z.object({
-  connectionId: z.string(),
-  projectId: z.string(),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-  url: z.string(),
-});
-
-const BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
-const BITBUCKET_MAX_LENGTH = 64;
-
-export const ExporterDestinationBitbucket = z.object({
-  connectionId: z.string(),
-  workspaceSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
-  projectKey: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
-  repoSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-  url: z.string(),
-});

package/src/codegen/export-jobs.ts

@@ -1,97 +0,0 @@
-import { PublishedDocEnvironment } from "../dsm";
-import {
-  ExporterDestinationSnDocs,
-  ExporterDestinationS3,
-  ExporterDestinationGithub,
-  ExporterDestinationGitlab,
-  ExporterDestinationBitbucket,
-  ExporterDestinationAzure,
-} from "./export-destinations";
-import { z } from "zod";
-
-export const ExporterJobDestination = z.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
-
-export const ExporterJobStatus = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
-
-export const ExporterJobLogEntryType = z.enum(["success", "info", "warning", "error", "user"]);
-
-export const ExporterJobLogEntry = z.object({
-  id: z.string().optional(),
-  time: z.coerce.date(),
-  type: ExporterJobLogEntryType,
-  message: z.string(),
-});
-
-export const ExporterJobResultPullRequestDestination = z.object({
-  pullRequestUrl: z.string(),
-});
-
-export const ExporterJobResultS3Destination = z.object({
-  bucket: z.string(),
-  urlPrefix: z.string().optional(),
-  path: z.string(),
-  files: z.array(z.string()),
-});
-
-export const ExporterJobResultDocsDestination = z.object({
-  url: z.string(),
-});
-
-export const ExporterJobResult = z.object({
-  error: z.string().optional(),
-  logs: z.array(ExporterJobLogEntry).optional(),
-  s3: ExporterJobResultS3Destination.optional(),
-  github: ExporterJobResultPullRequestDestination.optional(),
-  azure: ExporterJobResultPullRequestDestination.optional(),
-  gitlab: ExporterJobResultPullRequestDestination.optional(),
-  bitbucket: ExporterJobResultPullRequestDestination.optional(),
-  sndocs: ExporterJobResultDocsDestination.optional(),
-});
-
-export const ExporterJob = z.object({
-  id: z.coerce.string(),
-  createdAt: z.coerce.date(),
-  finishedAt: z.coerce.date().optional(),
-  designSystemId: z.coerce.string(),
-  designSystemVersionId: z.coerce.string(),
-  workspaceId: z.coerce.string(),
-  scheduleId: z.coerce.string().nullish(),
-  exporterId: z.coerce.string(),
-  brandId: z.coerce.string().optional(),
-  themeId: z.coerce.string().optional(),
-  estimatedExecutionTime: z.number().optional(),
-  status: ExporterJobStatus,
-  result: ExporterJobResult.optional(),
-  createdByUserId: z.string().optional(),
-
-  // CodegenDestinationsModel
-  webhookUrl: z.string().optional(),
-  destinationSnDocs: ExporterDestinationSnDocs.optional(),
-  destinationS3: ExporterDestinationS3.optional(),
-  destinationGithub: ExporterDestinationGithub.optional(),
-  destinationAzure: ExporterDestinationAzure.optional(),
-  destinationGitlab: ExporterDestinationGitlab.optional(),
-  destinationBitbucket: ExporterDestinationBitbucket.optional(),
-});
-
-export const ExporterJobFindByFilter = ExporterJob.pick({
-  exporterId: true,
-  designSystemVersionId: true,
-  destinations: true,
-  createdByUserId: true,
-  status: true,
-  scheduleId: true,
-  designSystemId: true,
-  themeId: true,
-  brandId: true,
-})
-  .extend({
-    destinations: z.array(ExporterJobDestination),
-    docsEnvironment: PublishedDocEnvironment,
-  })
-  .partial();
-
-export type ExporterJobDestination = z.infer<typeof ExporterJobDestination>;
-export type ExporterJobStatus = z.infer<typeof ExporterJobStatus>;
-export type ExporterJob = z.infer<typeof ExporterJob>;
-export type ExporterJobFindByFilter = z.infer<typeof ExporterJobFindByFilter>;

package/src/codegen/export-schedule.ts

@@ -1,37 +0,0 @@
-import {
-  ExporterDestinationSnDocs,
-  ExporterDestinationS3,
-  ExporterDestinationGithub,
-  ExporterDestinationGitlab,
-  ExporterDestinationBitbucket,
-  ExporterDestinationAzure,
-} from "./export-destinations";
-import { z } from "zod";
-
-export const ExporterScheduleEventType = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
-
-export const ExporterSchedule = z.object({
-  id: z.coerce.string(),
-
-  name: z.coerce.string(),
-  eventType: ExporterScheduleEventType,
-  isEnabled: z.coerce.boolean(),
-
-  workspaceId: z.coerce.string(),
-  designSystemId: z.coerce.string(),
-  exporterId: z.coerce.string(),
-  brandId: z.coerce.string().optional(),
-  themeId: z.coerce.string().optional(),
-
-  // CodegenDestinationsModel
-  webhookUrl: z.string().optional(),
-  destinationSnDocs: ExporterDestinationSnDocs.optional(),
-  destinationS3: ExporterDestinationS3.optional(),
-  destinationGithub: ExporterDestinationGithub.optional(),
-  destinationAzure: ExporterDestinationAzure.optional(),
-  destinationGitlab: ExporterDestinationGitlab.optional(),
-  destinationBitbucket: ExporterDestinationBitbucket.optional(),
-});
-
-export type ExporterScheduleEventType = z.infer<typeof ExporterScheduleEventType>;
-export type ExporterSchedule = z.infer<typeof ExporterSchedule>;