@scalar/types 0.1.13 → 0.1.14

package/dist/snippetz/snippetz.test-d.js

@@ -0,0 +1,28 @@
+import { assertType, describe, it } from "vitest";
+describe("TargetId", () => {
+  it("has node as a target", () => {
+    const target = "node";
+    assertType(target);
+  });
+  it("target doesn\u2019t exist", () => {
+    const target = "foo";
+    assertType(target);
+  });
+  it("has undici as a client", () => {
+    const client = "undici";
+    assertType(client);
+  });
+  it("client doesn\u2019t exist", () => {
+    const client = "does-not-exist";
+    assertType(client);
+  });
+  it("client exists, but target doesn\u2019t", () => {
+    const client = "undici";
+    assertType(client);
+  });
+  it("client does exist, but not for the given target", () => {
+    const client = "undici";
+    assertType(client);
+  });
+});
+//# sourceMappingURL=snippetz.test-d.js.map

package/dist/snippetz/snippetz.test-d.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/snippetz/snippetz.test-d.ts"],
+  "sourcesContent": ["import { assertType, describe, it } from 'vitest'\n\nimport type { ClientId, TargetId } from './index'\n\ndescribe('TargetId', () => {\n  it('has node as a target', () => {\n    const target = 'node'\n\n    assertType<TargetId>(target)\n  })\n\n  it('target doesn\u2019t exist', () => {\n    const target = 'foo'\n\n    // @ts-expect-error target doesn\u2019t exist\n    assertType<TargetId>(target)\n  })\n\n  it('has undici as a client', () => {\n    const client = 'undici'\n\n    assertType<ClientId<'node'>>(client)\n  })\n\n  it('client doesn\u2019t exist', () => {\n    const client = 'does-not-exist'\n\n    // @ts-expect-error client doesn\u2019t exist\n    assertType<ClientId<'node'>>(client)\n  })\n\n  it('client exists, but target doesn\u2019t', () => {\n    const client = 'undici'\n\n    // @ts-expect-error client exists, but target doesn\u2019t\n    assertType<ClientId<'foobar'>>(client)\n  })\n\n  it('client does exist, but not for the given target', () => {\n    const client = 'undici'\n\n    // @ts-expect-error client does exist, but not for the given target\n    assertType<ClientId<'shell'>>(client)\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,YAAY,UAAU,UAAU;AAIzC,SAAS,YAAY,MAAM;AACzB,KAAG,wBAAwB,MAAM;AAC/B,UAAM,SAAS;AAEf,eAAqB,MAAM;AAAA,EAC7B,CAAC;AAED,KAAG,6BAAwB,MAAM;AAC/B,UAAM,SAAS;AAGf,eAAqB,MAAM;AAAA,EAC7B,CAAC;AAED,KAAG,0BAA0B,MAAM;AACjC,UAAM,SAAS;AAEf,eAA6B,MAAM;AAAA,EACrC,CAAC;AAED,KAAG,6BAAwB,MAAM;AAC/B,UAAM,SAAS;AAGf,eAA6B,MAAM;AAAA,EACrC,CAAC;AAED,KAAG,0CAAqC,MAAM;AAC5C,UAAM,SAAS;AAGf,eAA+B,MAAM;AAAA,EACvC,CAAC;AAED,KAAG,mDAAmD,MAAM;AAC1D,UAAM,SAAS;AAGf,eAA8B,MAAM;AAAA,EACtC,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/index.d.ts

@@ -1,3 +1,3 @@
-export type { UnknownObject } from './utility-types.ts';
-export { type ENTITY_BRANDS, nanoidSchema } from './nanoid.ts';
+export type { UnknownObject } from './utility-types.js';
+export { type ENTITY_BRANDS, nanoidSchema } from './nanoid.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EAAE,KAAK,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,KAAK,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA"}

package/dist/utils/index.js

@@ -1 +1,5 @@
-export { nanoidSchema } from './nanoid.js';
+import { nanoidSchema } from "./nanoid.js";
+export {
+  nanoidSchema
+};
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/index.ts"],
+  "sourcesContent": ["export type { UnknownObject } from './utility-types'\nexport { type ENTITY_BRANDS, nanoidSchema } from './nanoid'\n"],
+  "mappings": "AACA,SAA6B,oBAAoB;",
+  "names": []
+}

package/dist/utils/nanoid.js

@@ -1,11 +1,7 @@
-import { nanoid } from 'nanoid';
-import { z } from 'zod';
-
-/** Generates a default value */
-const nanoidSchema = z
-    .string()
-    .min(7)
-    .optional()
-    .default(() => nanoid());
-
-export { nanoidSchema };
+import { nanoid } from "nanoid";
+import { z } from "zod";
+const nanoidSchema = z.string().min(7).optional().default(() => nanoid());
+export {
+  nanoidSchema
+};
+//# sourceMappingURL=nanoid.js.map

package/dist/utils/nanoid.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/nanoid.ts"],
+  "sourcesContent": ["import { nanoid } from 'nanoid'\nimport { z } from 'zod'\n\n/** Generates a default value */\nexport const nanoidSchema = z\n  .string()\n  .min(7)\n  .optional()\n  .default(() => nanoid())\n\n/** UID format for objects */\nexport type Nanoid = z.infer<typeof nanoidSchema>\n\n/** All of our Zod brands for entities, used to brand nanoidSchemas. */\nexport type ENTITY_BRANDS = {\n  COLLECTION: 'collection'\n  COOKIE: 'cookie'\n  ENVIRONMENT: 'environment'\n  EXAMPLE: 'example'\n  OPERATION: 'operation'\n  SECURITY_SCHEME: 'securityScheme'\n  SERVER: 'server'\n  TAG: 'tag'\n  WORKSPACE: 'workspace'\n}\n"],
+  "mappings": "AAAA,SAAS,cAAc;AACvB,SAAS,SAAS;AAGX,MAAM,eAAe,EACzB,OAAO,EACP,IAAI,CAAC,EACL,SAAS,EACT,QAAQ,MAAM,OAAO,CAAC;",
+  "names": []
+}

package/dist/utils/nanoid.test.js

@@ -0,0 +1,29 @@
+import { describe, it, expect } from "vitest";
+import { nanoidSchema } from "./nanoid.js";
+import { z } from "zod";
+describe("nanoidSchema", () => {
+  it("should generate a string with minimum length of 7 characters when no value is provided", () => {
+    const result = nanoidSchema.parse(void 0);
+    expect(typeof result).toBe("string");
+    expect(result.length).toBeGreaterThanOrEqual(7);
+  });
+  it("should accept valid strings with length >= 7", () => {
+    const validString = "1234567";
+    const result = nanoidSchema.parse(validString);
+    expect(result).toBe(validString);
+  });
+  it("should reject strings shorter than 7 characters", () => {
+    const invalidString = "123456";
+    expect(() => nanoidSchema.parse(invalidString)).toThrow(z.ZodError);
+  });
+  it("should generate different IDs for multiple calls", () => {
+    const id1 = nanoidSchema.parse(void 0);
+    const id2 = nanoidSchema.parse(void 0);
+    expect(id1).not.toBe(id2);
+  });
+  it("should properly type the generated ID as Nanoid", () => {
+    const id = nanoidSchema.parse(void 0);
+    expect(typeof id).toBe("string");
+  });
+});
+//# sourceMappingURL=nanoid.test.js.map

package/dist/utils/nanoid.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/nanoid.test.ts"],
+  "sourcesContent": ["import { describe, it, expect } from 'vitest'\nimport { nanoidSchema, type Nanoid } from './nanoid'\nimport { z } from 'zod'\n\ndescribe('nanoidSchema', () => {\n  it('should generate a string with minimum length of 7 characters when no value is provided', () => {\n    const result = nanoidSchema.parse(undefined)\n    expect(typeof result).toBe('string')\n    expect(result.length).toBeGreaterThanOrEqual(7)\n  })\n\n  it('should accept valid strings with length >= 7', () => {\n    const validString = '1234567'\n    const result = nanoidSchema.parse(validString)\n    expect(result).toBe(validString)\n  })\n\n  it('should reject strings shorter than 7 characters', () => {\n    const invalidString = '123456'\n    expect(() => nanoidSchema.parse(invalidString)).toThrow(z.ZodError)\n  })\n\n  it('should generate different IDs for multiple calls', () => {\n    const id1 = nanoidSchema.parse(undefined)\n    const id2 = nanoidSchema.parse(undefined)\n    expect(id1).not.toBe(id2)\n  })\n\n  it('should properly type the generated ID as Nanoid', () => {\n    const id: Nanoid = nanoidSchema.parse(undefined)\n    expect(typeof id).toBe('string')\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,IAAI,cAAc;AACrC,SAAS,oBAAiC;AAC1C,SAAS,SAAS;AAElB,SAAS,gBAAgB,MAAM;AAC7B,KAAG,0FAA0F,MAAM;AACjG,UAAM,SAAS,aAAa,MAAM,MAAS;AAC3C,WAAO,OAAO,MAAM,EAAE,KAAK,QAAQ;AACnC,WAAO,OAAO,MAAM,EAAE,uBAAuB,CAAC;AAAA,EAChD,CAAC;AAED,KAAG,gDAAgD,MAAM;AACvD,UAAM,cAAc;AACpB,UAAM,SAAS,aAAa,MAAM,WAAW;AAC7C,WAAO,MAAM,EAAE,KAAK,WAAW;AAAA,EACjC,CAAC;AAED,KAAG,mDAAmD,MAAM;AAC1D,UAAM,gBAAgB;AACtB,WAAO,MAAM,aAAa,MAAM,aAAa,CAAC,EAAE,QAAQ,EAAE,QAAQ;AAAA,EACpE,CAAC;AAED,KAAG,oDAAoD,MAAM;AAC3D,UAAM,MAAM,aAAa,MAAM,MAAS;AACxC,UAAM,MAAM,aAAa,MAAM,MAAS;AACxC,WAAO,GAAG,EAAE,IAAI,KAAK,GAAG;AAAA,EAC1B,CAAC;AAED,KAAG,mDAAmD,MAAM;AAC1D,UAAM,KAAa,aAAa,MAAM,MAAS;AAC/C,WAAO,OAAO,EAAE,EAAE,KAAK,QAAQ;AAAA,EACjC,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/utility-types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=utility-types.js.map

package/dist/utils/utility-types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/package.json

@@ -16,7 +16,7 @@
     "scalar",
     "references"
   ],
-  "version": "0.1.13",
+  "version": "0.1.14",
   "engines": {
     "node": ">=18"
   },
@@ -59,22 +59,18 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@unhead/schema": "^1.11.11",
     "nanoid": "^5.1.5",
-    "type-fest": "^4.20.0",
     "zod": "3.24.1",
-    "@scalar/openapi-types": "0.2.1"
+    "@scalar/openapi-types": "0.2.2"
   },
   "devDependencies": {
     "@types/har-format": "^1.2.15",
+    "type-fest": "^4.20.0",
     "vite": "^5.4.10",
-    "vitest": "^1.6.0",
-    "@scalar/build-tooling": "0.1.18"
+    "@scalar/build-tooling": "0.1.19"
   },
   "scripts": {
-    "build": "scalar-build-rollup",
-    "format": "scalar-format",
-    "format:check": "scalar-format-check",
+    "build": "scalar-build-esbuild",
     "lint:check": "scalar-lint-check",
     "lint:fix": "scalar-lint-fix",
     "test": "vitest",

package/dist/api-reference/helpers/migrate-theme-variables.d.ts

@@ -1,10 +0,0 @@
-/** The legacy -> updated CSS variable prefix pairs */
-export declare const PREFIX_MIGRATIONS: readonly [readonly ["--theme-", "--scalar-"], readonly ["--sidebar-", "--scalar-sidebar-"]];
-export declare const LEGACY_PREFIXES: ("--theme-" | "--sidebar-")[];
-/**
- * Checks a style string for legacy theme variables and updated them to the new theme variables
- *
- * @param styles the style string to be checked for legacy theme variables and updated
- */
-export declare function migrateThemeVariables(styles: string): string;
-//# sourceMappingURL=migrate-theme-variables.d.ts.map

package/dist/api-reference/helpers/migrate-theme-variables.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"migrate-theme-variables.d.ts","sourceRoot":"","sources":["../../../src/api-reference/helpers/migrate-theme-variables.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,eAAO,MAAM,iBAAiB,6FAGpB,CAAA;AAEV,eAAO,MAAM,eAAe,+BAA8C,CAAA;AAE1E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAY5D"}

package/dist/api-reference/helpers/migrate-theme-variables.js

@@ -1,22 +0,0 @@
-/** The legacy -> updated CSS variable prefix pairs */
-const PREFIX_MIGRATIONS = [
-    ['--theme-', '--scalar-'],
-    ['--sidebar-', '--scalar-sidebar-'],
-];
-const LEGACY_PREFIXES = PREFIX_MIGRATIONS.map(([legacy]) => legacy);
-/**
- * Checks a style string for legacy theme variables and updated them to the new theme variables
- *
- * @param styles the style string to be checked for legacy theme variables and updated
- */
-function migrateThemeVariables(styles) {
-    const hasLegacyPrefixes = LEGACY_PREFIXES.some((p) => styles.includes(p));
-    if (!hasLegacyPrefixes) {
-        return styles;
-    }
-    console.warn(`DEPRECATION WARNING: It looks like you're using legacy CSS variables in your custom CSS string. Please migrate them to use the updated prefixes. See https://github.com/scalar/scalar/blob/main/documentation/themes.md#theme-prefix-changes`);
-    // Replaces each old variable in the prefix migrations
-    return PREFIX_MIGRATIONS.reduce((s, [o, n]) => s.replaceAll(o, n), styles);
-}
-
-export { LEGACY_PREFIXES, PREFIX_MIGRATIONS, migrateThemeVariables };