@supernova-studio/model 0.16.0 → 0.17.0

package/dist/index.mjs

@@ -2971,6 +2971,24 @@ var DesignSystemVersionRoom = Entity.extend({
   designSystemVersionId: z119.string(),
   liveblocksId: z119.string()
 });
+var DesignSystemVersionRoomInitialState = z119.object({
+  pages: z119.array(DocumentationPageV2),
+  groups: z119.array(ElementGroup),
+  deletedPagePersistentIds: z119.array(z119.string()),
+  deletedGroupPersistentIds: z119.array(z119.string())
+});
+var DesignSystemVersionRoomUpdate = DesignSystemVersionRoomInitialState.extend({
+  deletedPagePersistentIds: z119.array(z119.string()),
+  deletedGroupPersistentIds: z119.array(z119.string())
+});
+function mergeDesignSystemVersionRoomUpdates(lhs, rhs) {
+  return {
+    pages: [...lhs.pages, ...rhs.pages],
+    groups: [...lhs.groups, ...rhs.groups],
+    deletedPagePersistentIds: [...lhs.deletedPagePersistentIds, ...rhs.deletedPagePersistentIds],
+    deletedGroupPersistentIds: [...lhs.deletedGroupPersistentIds, ...rhs.deletedGroupPersistentIds]
+  };
+}
 
 // src/multiplayer/documentation-page-room.ts
 import { z as z120 } from "zod";
@@ -3035,6 +3053,131 @@ var PersonalAccessToken = z124.object({
   scope: z124.string().optional()
 });
 
+// src/utils/errors.ts
+var SupernovaException = class _SupernovaException extends Error {
+  //
+  // Properties
+  //
+  constructor(type, message) {
+    super(`${type}: ${message}`);
+    this.type = type;
+  }
+  static wrongFormat(message) {
+    return new _SupernovaException("WrongFormat", message);
+  }
+  static accessDenied(message) {
+    return new _SupernovaException("AccessDenied", message);
+  }
+  static notFound(message) {
+    return new _SupernovaException("ResourceNotFound", message);
+  }
+  static timeout(message) {
+    return new _SupernovaException("Timeout", message);
+  }
+  static conflict(message) {
+    return new _SupernovaException("Conflict", message);
+  }
+  static notImplemented(message) {
+    return new _SupernovaException("NotImplemented", message);
+  }
+  static wrongActionOrder(message) {
+    return new _SupernovaException("WrongActionOrder", message);
+  }
+  static invalidOperation(message) {
+    return new _SupernovaException("InvalidOperation", message);
+  }
+  static shouldNotHappen(message) {
+    return new _SupernovaException("UnexpectedError", message);
+  }
+  static ipRestricted(message) {
+    return new _SupernovaException("IPRestricted", message);
+  }
+  static planRestricted(message) {
+    return new _SupernovaException("PlanRestricted", message);
+  }
+  static missingWorkspacePermission(message) {
+    return new _SupernovaException("MissingWorkspacePermission", message);
+  }
+  static missingExporterPermission(message) {
+    return new _SupernovaException("MissingExporterPermission", message);
+  }
+  static missingIntegration(message) {
+    return new _SupernovaException("AccessDenied", message);
+  }
+  static noAccess(message) {
+    return new _SupernovaException("NoAccess", message);
+  }
+  //
+  // To refactor
+  //
+  static badRequest(message) {
+    return new _SupernovaException("BadRequest", message);
+  }
+};
+
+// src/utils/common.ts
+function forceUnwrapNullish(value) {
+  if (value === null)
+    throw new Error("Illegal null");
+  if (value === void 0)
+    throw new Error("Illegal undefined");
+  return value;
+}
+function trimLeadingSlash(string) {
+  return string.startsWith("/") ? string.substring(1) : string;
+}
+function trimTrailingSlash(string) {
+  return string.endsWith("/") ? string.substring(0, string.length - 1) : string;
+}
+function parseUrl(url) {
+  return new URL(url.startsWith("https://") || url.startsWith("http://") ? url : `https://${url}`);
+}
+function mapByUnique(items, keyFn) {
+  const result = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    result.set(keyFn(item), item);
+  }
+  return result;
+}
+function groupBy(items, keyFn) {
+  const result = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    const key = keyFn(item);
+    const array = result.get(key);
+    if (array) {
+      array.push(item);
+    } else {
+      result.set(key, [item]);
+    }
+  }
+  return result;
+}
+function filterNonNullish(items) {
+  return items.filter(Boolean);
+}
+function nonNullishFilter(item) {
+  return !!item;
+}
+function nonNullFilter(item) {
+  return item !== null;
+}
+function buildConstantEnum(values) {
+  const constMap = values.reduce((acc, code) => ({ ...acc, [code]: code }), {});
+  return constMap;
+}
+async function promiseWithTimeout(timeoutMs, promise) {
+  let timeoutHandle;
+  const timeoutPromise = new Promise((_, reject) => {
+    timeoutHandle = setTimeout(() => reject(SupernovaException.timeout()), timeoutMs);
+  });
+  const result = await Promise.race([promise(), timeoutPromise]);
+  clearTimeout(timeoutHandle);
+  return result;
+}
+async function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
 // src/utils/content-loader-instruction.ts
 import { z as z125 } from "zod";
 var ContentLoadInstruction = z125.object({
@@ -3058,6 +3201,638 @@ var ContentLoaderPayload = z125.object({
     location: z125.string()
   })
 );
+
+// src/utils/slugify.ts
+import slugifyImplementation from "@sindresorhus/slugify";
+function slugify(str, options) {
+  const slug = slugifyImplementation(str ?? "", options);
+  return slug?.length > 0 ? slug : "item";
+}
+var RESERVED_SLUGS = [
+  "workspaces",
+  "workspace",
+  "api0",
+  "api1",
+  "api2",
+  "custom",
+  "x-sn-reserved",
+  // further elements copied from https://github.com/shouldbee/reserved-usernames/blob/master/reserved-usernames.json
+  "0",
+  "about",
+  "access",
+  "account",
+  "accounts",
+  "activate",
+  "activities",
+  "activity",
+  "ad",
+  "add",
+  "address",
+  "adm",
+  "admin",
+  "administration",
+  "administrator",
+  "ads",
+  "adult",
+  "advertising",
+  "affiliate",
+  "affiliates",
+  "ajax",
+  "all",
+  "alpha",
+  "analysis",
+  "analytics",
+  "android",
+  "anon",
+  "anonymous",
+  "api",
+  "app",
+  "apps",
+  "archive",
+  "archives",
+  "article",
+  "asct",
+  "asset",
+  "assets",
+  "atom",
+  "auth",
+  "authentication",
+  "avatar",
+  "backup",
+  "balancer-manager",
+  "banner",
+  "banners",
+  "beta",
+  "billing",
+  "bin",
+  "blog",
+  "blogs",
+  "board",
+  "book",
+  "bookmark",
+  "bot",
+  "bots",
+  "bug",
+  "business",
+  "cache",
+  "cadastro",
+  "calendar",
+  "call",
+  "campaign",
+  "cancel",
+  "captcha",
+  "career",
+  "careers",
+  "cart",
+  "categories",
+  "category",
+  "cgi",
+  "cgi-bin",
+  "changelog",
+  "chat",
+  "check",
+  "checking",
+  "checkout",
+  "client",
+  "cliente",
+  "clients",
+  "code",
+  "codereview",
+  "comercial",
+  "comment",
+  "comments",
+  "communities",
+  "community",
+  "company",
+  "compare",
+  "compras",
+  "config",
+  "configuration",
+  "connect",
+  "contact",
+  "contact-us",
+  "contact_us",
+  "contactus",
+  "contest",
+  "contribute",
+  "corp",
+  "create",
+  "css",
+  "dashboard",
+  "data",
+  "db",
+  "default",
+  "delete",
+  "demo",
+  "design",
+  "designer",
+  "destroy",
+  "dev",
+  "devel",
+  "developer",
+  "developers",
+  "diagram",
+  "diary",
+  "dict",
+  "dictionary",
+  "die",
+  "dir",
+  "direct_messages",
+  "directory",
+  "dist",
+  "doc",
+  "docs",
+  "documentation",
+  "domain",
+  "download",
+  "downloads",
+  "ecommerce",
+  "edit",
+  "editor",
+  "edu",
+  "education",
+  "email",
+  "employment",
+  "empty",
+  "end",
+  "enterprise",
+  "entries",
+  "entry",
+  "error",
+  "errors",
+  "eval",
+  "event",
+  "exit",
+  "explore",
+  "facebook",
+  "faq",
+  "favorite",
+  "favorites",
+  "feature",
+  "features",
+  "feed",
+  "feedback",
+  "feeds",
+  "file",
+  "files",
+  "first",
+  "flash",
+  "fleet",
+  "fleets",
+  "flog",
+  "follow",
+  "followers",
+  "following",
+  "forgot",
+  "form",
+  "forum",
+  "forums",
+  "founder",
+  "free",
+  "friend",
+  "friends",
+  "ftp",
+  "gadget",
+  "gadgets",
+  "game",
+  "games",
+  "get",
+  "ghost",
+  "gift",
+  "gifts",
+  "gist",
+  "github",
+  "graph",
+  "group",
+  "groups",
+  "guest",
+  "guests",
+  "help",
+  "home",
+  "homepage",
+  "host",
+  "hosting",
+  "hostmaster",
+  "hostname",
+  "howto",
+  "hpg",
+  "html",
+  "http",
+  "httpd",
+  "https",
+  "i",
+  "iamges",
+  "icon",
+  "icons",
+  "id",
+  "idea",
+  "ideas",
+  "image",
+  "images",
+  "imap",
+  "img",
+  "index",
+  "indice",
+  "info",
+  "information",
+  "inquiry",
+  "instagram",
+  "intranet",
+  "invitations",
+  "invite",
+  "ipad",
+  "iphone",
+  "irc",
+  "is",
+  "issue",
+  "issues",
+  "it",
+  "item",
+  "items",
+  "java",
+  "javascript",
+  "job",
+  "jobs",
+  "join",
+  "js",
+  "json",
+  "jump",
+  "knowledgebase",
+  "language",
+  "languages",
+  "last",
+  "ldap-status",
+  "legal",
+  "license",
+  "link",
+  "links",
+  "linux",
+  "list",
+  "lists",
+  "log",
+  "log-in",
+  "log-out",
+  "log_in",
+  "log_out",
+  "login",
+  "logout",
+  "logs",
+  "m",
+  "mac",
+  "mail",
+  "mail1",
+  "mail2",
+  "mail3",
+  "mail4",
+  "mail5",
+  "mailer",
+  "mailing",
+  "maintenance",
+  "manager",
+  "manual",
+  "map",
+  "maps",
+  "marketing",
+  "master",
+  "me",
+  "media",
+  "member",
+  "members",
+  "message",
+  "messages",
+  "messenger",
+  "microblog",
+  "microblogs",
+  "mine",
+  "mis",
+  "mob",
+  "mobile",
+  "movie",
+  "movies",
+  "mp3",
+  "msg",
+  "msn",
+  "music",
+  "musicas",
+  "mx",
+  "my",
+  "mysql",
+  "name",
+  "named",
+  "nan",
+  "navi",
+  "navigation",
+  "net",
+  "network",
+  "new",
+  "news",
+  "newsletter",
+  "nick",
+  "nickname",
+  "notes",
+  "noticias",
+  "notification",
+  "notifications",
+  "notify",
+  "ns",
+  "ns1",
+  "ns10",
+  "ns2",
+  "ns3",
+  "ns4",
+  "ns5",
+  "ns6",
+  "ns7",
+  "ns8",
+  "ns9",
+  "null",
+  "oauth",
+  "oauth_clients",
+  "offer",
+  "offers",
+  "official",
+  "old",
+  "online",
+  "openid",
+  "operator",
+  "order",
+  "orders",
+  "organization",
+  "organizations",
+  "overview",
+  "owner",
+  "owners",
+  "page",
+  "pager",
+  "pages",
+  "panel",
+  "password",
+  "payment",
+  "perl",
+  "phone",
+  "photo",
+  "photoalbum",
+  "photos",
+  "php",
+  "phpmyadmin",
+  "phppgadmin",
+  "phpredisadmin",
+  "pic",
+  "pics",
+  "ping",
+  "plan",
+  "plans",
+  "plugin",
+  "plugins",
+  "policy",
+  "pop",
+  "pop3",
+  "popular",
+  "portal",
+  "post",
+  "postfix",
+  "postmaster",
+  "posts",
+  "pr",
+  "premium",
+  "press",
+  "price",
+  "pricing",
+  "privacy",
+  "privacy-policy",
+  "privacy_policy",
+  "privacypolicy",
+  "private",
+  "product",
+  "products",
+  "profile",
+  "project",
+  "projects",
+  "promo",
+  "pub",
+  "public",
+  "purpose",
+  "put",
+  "python",
+  "query",
+  "random",
+  "ranking",
+  "read",
+  "readme",
+  "recent",
+  "recruit",
+  "recruitment",
+  "register",
+  "registration",
+  "release",
+  "remove",
+  "replies",
+  "report",
+  "reports",
+  "repositories",
+  "repository",
+  "req",
+  "request",
+  "requests",
+  "reset",
+  "roc",
+  "root",
+  "rss",
+  "ruby",
+  "rule",
+  "sag",
+  "sale",
+  "sales",
+  "sample",
+  "samples",
+  "save",
+  "school",
+  "script",
+  "scripts",
+  "search",
+  "secure",
+  "security",
+  "self",
+  "send",
+  "server",
+  "server-info",
+  "server-status",
+  "service",
+  "services",
+  "session",
+  "sessions",
+  "setting",
+  "settings",
+  "setup",
+  "share",
+  "shop",
+  "show",
+  "sign-in",
+  "sign-up",
+  "sign_in",
+  "sign_up",
+  "signin",
+  "signout",
+  "signup",
+  "site",
+  "sitemap",
+  "sites",
+  "smartphone",
+  "smtp",
+  "soporte",
+  "source",
+  "spec",
+  "special",
+  "sql",
+  "src",
+  "ssh",
+  "ssl",
+  "ssladmin",
+  "ssladministrator",
+  "sslwebmaster",
+  "staff",
+  "stage",
+  "staging",
+  "start",
+  "stat",
+  "state",
+  "static",
+  "stats",
+  "status",
+  "store",
+  "stores",
+  "stories",
+  "style",
+  "styleguide",
+  "stylesheet",
+  "stylesheets",
+  "subdomain",
+  "subscribe",
+  "subscriptions",
+  "suporte",
+  "support",
+  "svn",
+  "swf",
+  "sys",
+  "sysadmin",
+  "sysadministrator",
+  "system",
+  "tablet",
+  "tablets",
+  "tag",
+  "talk",
+  "task",
+  "tasks",
+  "team",
+  "teams",
+  "tech",
+  "telnet",
+  "term",
+  "terms",
+  "terms-of-service",
+  "terms_of_service",
+  "termsofservice",
+  "test",
+  "test1",
+  "test2",
+  "test3",
+  "teste",
+  "testing",
+  "tests",
+  "theme",
+  "themes",
+  "thread",
+  "threads",
+  "tmp",
+  "todo",
+  "tool",
+  "tools",
+  "top",
+  "topic",
+  "topics",
+  "tos",
+  "tour",
+  "translations",
+  "trends",
+  "tutorial",
+  "tux",
+  "tv",
+  "twitter",
+  "undef",
+  "unfollow",
+  "unsubscribe",
+  "update",
+  "upload",
+  "uploads",
+  "url",
+  "usage",
+  "user",
+  "username",
+  "users",
+  "usuario",
+  "vendas",
+  "ver",
+  "version",
+  "video",
+  "videos",
+  "visitor",
+  "watch",
+  "weather",
+  "web",
+  "webhook",
+  "webhooks",
+  "webmail",
+  "webmaster",
+  "website",
+  "websites",
+  "welcome",
+  "widget",
+  "widgets",
+  "wiki",
+  "win",
+  "windows",
+  "word",
+  "work",
+  "works",
+  "workshop",
+  "ww",
+  "wws",
+  "www",
+  "www1",
+  "www2",
+  "www3",
+  "www4",
+  "www5",
+  "www6",
+  "www7",
+  "wwws",
+  "wwww",
+  "xfn",
+  "xml",
+  "xmpp",
+  "xpg",
+  "xxx",
+  "yaml",
+  "year",
+  "yml",
+  "you",
+  "yourdomain",
+  "yourname",
+  "yoursite",
+  "yourusername",
+  "latest",
+  "live",
+  "preview",
+  "learn",
+  "supernova",
+  "super-nova"
+];
+var RESERVED_SLUGS_SET = new Set(RESERVED_SLUGS);
+var RESERVED_SLUG_PREFIX = "x-sn-reserved-";
+var isSlugReservedInternal = (slug) => slug?.startsWith(RESERVED_SLUG_PREFIX);
+function isSlugReserved(slug) {
+  return RESERVED_SLUGS_SET.has(slug) || isSlugReservedInternal(slug);
+}
 export {
   Address,
   Asset,
@@ -3138,6 +3913,8 @@ export {
   DesignSystemSwitcher,
   DesignSystemUpdateInput,
   DesignSystemVersionRoom,
+  DesignSystemVersionRoomInitialState,
+  DesignSystemVersionRoomUpdate,
   DesignSystemWithWorkspace,
   DesignToken,
   DesignTokenImportModel,
@@ -3438,6 +4215,8 @@ export {
   PulsarContributionVariant,
   PulsarCustomBlock,
   PulsarPropertyType,
+  RESERVED_SLUGS,
+  RESERVED_SLUG_PREFIX,
   RoomType,
   RoomTypeEnum,
   RoomTypeSchema,
@@ -3468,6 +4247,7 @@ export {
   StripeSubscriptionStatus,
   StripeSubscriptionStatusSchema,
   Subscription,
+  SupernovaException,
   TextCase,
   TextCaseTokenData,
   TextCaseValue,
@@ -3522,6 +4302,7 @@ export {
   ZIndexUnit,
   ZIndexValue,
   addImportModelCollections,
+  buildConstantEnum,
   colorValueFormatDescription,
   colorValueRegex,
   defaultDocumentationItemConfiguration,
@@ -3531,19 +4312,33 @@ export {
   extractTokenTypedData,
   figmaFileStructureImportModelToMap,
   figmaFileStructureToMap,
+  filterNonNullish,
+  forceUnwrapNullish,
+  groupBy,
   isDesignTokenImportModelOfType,
   isDesignTokenOfType,
   isImportedAsset,
   isImportedComponent,
   isImportedDesignToken,
+  isSlugReserved,
   isTokenType,
+  mapByUnique,
+  mergeDesignSystemVersionRoomUpdates,
+  nonNullFilter,
+  nonNullishFilter,
   nullishToOptional,
+  parseUrl,
+  promiseWithTimeout,
   publishedDocEnvironments,
+  sleep,
   slugRegex,
+  slugify,
   tokenAliasOrValue,
   tokenElementTypes,
   traversePageBlocksV1,
   traverseStructure,
+  trimLeadingSlash,
+  trimTrailingSlash,
   tryParseShortPersistentId,
   zodCreateInputOmit,
   zodUpdateInputOmit