@scalar/helpers 0.2.2 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scalar/helpers
 
+## 0.2.5
+
+### Patch Changes
+
+- [#7605](https://github.com/scalar/scalar/pull/7605): fix: all issues for client modal v2 preparation
+
+## 0.2.4
+
+### Patch Changes
+
+- [#7581](https://github.com/scalar/scalar/pull/7581): fix: npm publish job
+- [#7567](https://github.com/scalar/scalar/pull/7567): feat: add code samples to client v2
+
+## 0.2.3
+
+### Patch Changes
+
+- [#7575](https://github.com/scalar/scalar/pull/7575): feat: add support for object examples + hide body when empty
+
 ## 0.2.2
 
 ### Patch Changes

package/dist/array/add-to-map-array.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A little helper to add a value to a map array where the type is Map<string, any[]>
+ */
+export declare const addToMapArray: (map: Map<string, unknown[]>, key: string, value: unknown) => void;
+//# sourceMappingURL=add-to-map-array.d.ts.map

package/dist/array/add-to-map-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-to-map-array.d.ts","sourceRoot":"","sources":["../../src/array/add-to-map-array.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,KAAK,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,MAAM,EAAE,OAAO,OAAO,SAIrF,CAAA"}

package/dist/array/add-to-map-array.js

@@ -0,0 +1,9 @@
+const addToMapArray = (map, key, value) => {
+  const prev = map.get(key) ?? [];
+  prev.push(value);
+  map.set(key, prev);
+};
+export {
+  addToMapArray
+};
+//# sourceMappingURL=add-to-map-array.js.map

package/dist/array/add-to-map-array.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/array/add-to-map-array.ts"],
+  "sourcesContent": ["/**\n * A little helper to add a value to a map array where the type is Map<string, any[]>\n */\nexport const addToMapArray = (map: Map<string, unknown[]>, key: string, value: unknown) => {\n  const prev = map.get(key) ?? []\n  prev.push(value)\n  map.set(key, prev)\n}\n"],
+  "mappings": "AAGO,MAAM,gBAAgB,CAAC,KAA6B,KAAa,UAAmB;AACzF,QAAM,OAAO,IAAI,IAAI,GAAG,KAAK,CAAC;AAC9B,OAAK,KAAK,KAAK;AACf,MAAI,IAAI,KAAK,IAAI;AACnB;",
+  "names": []
+}

package/dist/object/local-storage.d.ts

@@ -18,22 +18,33 @@ export declare const LS_KEYS: {
  * to ensure we do not have any conflicts
  */
 export declare const REFERENCE_LS_KEYS: {
-    /**
-     * We should remove after some time as we no longer store an object
-     * @deprecated
-     */
-    readonly SELECTED_CLIENT_DEPRECATED: "scalar-reference-selected-client";
     /**
      * Store the selected client as a string in localStorage
      */
     readonly SELECTED_CLIENT: "scalar-reference-selected-client-v2";
+    /**
+     * Store the auth schemes as a string in localStorage
+     */
+    readonly AUTH_SCHEMES: "scalar-reference-auth-schemes";
+    /**
+     * Store the selected auth schemes as a string in localStorage
+     */
+    readonly SELECTED_AUTH_SCHEMES: "scalar-reference-selected-auth-schemes";
 };
 /**
  * localStorage keys for all client resources
  * to ensure we do not have any conflicts
  */
 export declare const CLIENT_LS_KEYS: {
+    /**
+     * @deprecated This key is deprecated and will be removed in a future release.
+     * We are now storing the entire document for the api-client instead.
+     */
     readonly AUTH: "scalar-client-auth";
+    /**
+     * @deprecated This key is deprecated and will be removed in a future release.
+     * We are now storing the entire document for the api-client instead.
+     */
     readonly SELECTED_SECURITY_SCHEMES: "scalar-client-selected-security-schemes";
 };
 /** SSR safe alias for localStorage */

package/dist/object/local-storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"local-storage.d.ts","sourceRoot":"","sources":["../../src/object/local-storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;CAUV,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;;OAGG;;IAEH;;OAEG;;CAEK,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,cAAc;;;CAGjB,CAAA;AAEV,sCAAsC;AACtC,eAAO,MAAM,gBAAgB;;;;CAOX,CAAA"}
+{"version":3,"file":"local-storage.d.ts","sourceRoot":"","sources":["../../src/object/local-storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;CAUV,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,cAAc;IACzB;;;OAGG;;IAEH;;;OAGG;;CAEK,CAAA;AAEV,sCAAsC;AACtC,eAAO,MAAM,gBAAgB;;;;CAOX,CAAA"}

package/dist/object/local-storage.js

@@ -11,17 +11,28 @@ const LS_KEYS = {
 };
 const REFERENCE_LS_KEYS = {
   /**
-   * We should remove after some time as we no longer store an object
-   * @deprecated
+   * Store the selected client as a string in localStorage
    */
-  SELECTED_CLIENT_DEPRECATED: "scalar-reference-selected-client",
+  SELECTED_CLIENT: "scalar-reference-selected-client-v2",
   /**
-   * Store the selected client as a string in localStorage
+   * Store the auth schemes as a string in localStorage
+   */
+  AUTH_SCHEMES: "scalar-reference-auth-schemes",
+  /**
+   * Store the selected auth schemes as a string in localStorage
    */
-  SELECTED_CLIENT: "scalar-reference-selected-client-v2"
+  SELECTED_AUTH_SCHEMES: "scalar-reference-selected-auth-schemes"
 };
 const CLIENT_LS_KEYS = {
+  /**
+   * @deprecated This key is deprecated and will be removed in a future release.
+   * We are now storing the entire document for the api-client instead.
+   */
   AUTH: "scalar-client-auth",
+  /**
+   * @deprecated This key is deprecated and will be removed in a future release.
+   * We are now storing the entire document for the api-client instead.
+   */
   SELECTED_SECURITY_SCHEMES: "scalar-client-selected-security-schemes"
 };
 const safeLocalStorage = () => typeof window === "undefined" ? {

package/dist/object/local-storage.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/object/local-storage.ts"],
-  "sourcesContent": ["/**\n * localStorage keys for resources\n * DO NOT CHANGE THESE AS IT WILL BREAK THE MIGRATION\n */\nexport const LS_KEYS = {\n  COLLECTION: 'collection',\n  COOKIE: 'cookie',\n  ENVIRONMENT: 'environment',\n  REQUEST: 'request',\n  REQUEST_EXAMPLE: 'requestExample',\n  SECURITY_SCHEME: 'securityScheme',\n  SERVER: 'server',\n  TAG: 'tag',\n  WORKSPACE: 'workspace',\n} as const\n\n/**\n * localStorage keys for all reference resources\n * to ensure we do not have any conflicts\n */\nexport const REFERENCE_LS_KEYS = {\n  /**\n   * We should remove after some time as we no longer store an object\n   * @deprecated\n   */\n  SELECTED_CLIENT_DEPRECATED: 'scalar-reference-selected-client',\n  /**\n   * Store the selected client as a string in localStorage\n   */\n  SELECTED_CLIENT: 'scalar-reference-selected-client-v2',\n} as const\n\n/**\n * localStorage keys for all client resources\n * to ensure we do not have any conflicts\n */\nexport const CLIENT_LS_KEYS = {\n  AUTH: 'scalar-client-auth',\n  SELECTED_SECURITY_SCHEMES: 'scalar-client-selected-security-schemes',\n} as const\n\n/** SSR safe alias for localStorage */\nexport const safeLocalStorage = () =>\n  typeof window === 'undefined'\n    ? {\n        getItem: () => null,\n        setItem: () => null,\n        removeItem: () => null,\n      }\n    : localStorage\n"],
-  "mappings": "AAIO,MAAM,UAAU;AAAA,EACrB,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,aAAa;AAAA,EACb,SAAS;AAAA,EACT,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,QAAQ;AAAA,EACR,KAAK;AAAA,EACL,WAAW;AACb;AAMO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA;AAAA,EAK/B,4BAA4B;AAAA;AAAA;AAAA;AAAA,EAI5B,iBAAiB;AACnB;AAMO,MAAM,iBAAiB;AAAA,EAC5B,MAAM;AAAA,EACN,2BAA2B;AAC7B;AAGO,MAAM,mBAAmB,MAC9B,OAAO,WAAW,cACd;AAAA,EACE,SAAS,MAAM;AAAA,EACf,SAAS,MAAM;AAAA,EACf,YAAY,MAAM;AACpB,IACA;",
+  "sourcesContent": ["/**\n * localStorage keys for resources\n * DO NOT CHANGE THESE AS IT WILL BREAK THE MIGRATION\n */\nexport const LS_KEYS = {\n  COLLECTION: 'collection',\n  COOKIE: 'cookie',\n  ENVIRONMENT: 'environment',\n  REQUEST: 'request',\n  REQUEST_EXAMPLE: 'requestExample',\n  SECURITY_SCHEME: 'securityScheme',\n  SERVER: 'server',\n  TAG: 'tag',\n  WORKSPACE: 'workspace',\n} as const\n\n/**\n * localStorage keys for all reference resources\n * to ensure we do not have any conflicts\n */\nexport const REFERENCE_LS_KEYS = {\n  /**\n   * Store the selected client as a string in localStorage\n   */\n  SELECTED_CLIENT: 'scalar-reference-selected-client-v2',\n  /**\n   * Store the auth schemes as a string in localStorage\n   */\n  AUTH_SCHEMES: 'scalar-reference-auth-schemes',\n  /**\n   * Store the selected auth schemes as a string in localStorage\n   */\n  SELECTED_AUTH_SCHEMES: 'scalar-reference-selected-auth-schemes',\n} as const\n\n/**\n * localStorage keys for all client resources\n * to ensure we do not have any conflicts\n */\nexport const CLIENT_LS_KEYS = {\n  /**\n   * @deprecated This key is deprecated and will be removed in a future release.\n   * We are now storing the entire document for the api-client instead.\n   */\n  AUTH: 'scalar-client-auth',\n  /**\n   * @deprecated This key is deprecated and will be removed in a future release.\n   * We are now storing the entire document for the api-client instead.\n   */\n  SELECTED_SECURITY_SCHEMES: 'scalar-client-selected-security-schemes',\n} as const\n\n/** SSR safe alias for localStorage */\nexport const safeLocalStorage = () =>\n  typeof window === 'undefined'\n    ? {\n        getItem: () => null,\n        setItem: () => null,\n        removeItem: () => null,\n      }\n    : localStorage\n"],
+  "mappings": "AAIO,MAAM,UAAU;AAAA,EACrB,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,aAAa;AAAA,EACb,SAAS;AAAA,EACT,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,QAAQ;AAAA,EACR,KAAK;AAAA,EACL,WAAW;AACb;AAMO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAI/B,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAIjB,cAAc;AAAA;AAAA;AAAA;AAAA,EAId,uBAAuB;AACzB;AAMO,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA,EAK5B,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAKN,2BAA2B;AAC7B;AAGO,MAAM,mBAAmB,MAC9B,OAAO,WAAW,cACd;AAAA,EACE,SAAS,MAAM;AAAA,EACf,SAAS,MAAM;AAAA,EACf,YAAY,MAAM;AACpB,IACA;",
   "names": []
 }

package/dist/object/object-entries.d.ts

@@ -0,0 +1,3 @@
+/** Type safe version of Object.entries */
+export declare const objectEntries: <T extends object>(obj: T) => [keyof T, T[keyof T]][];
+//# sourceMappingURL=object-entries.d.ts.map

package/dist/object/object-entries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-entries.d.ts","sourceRoot":"","sources":["../../src/object/object-entries.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAAE,KAAK,CAAC,KAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAC9B,CAAA"}

package/dist/object/object-entries.js

@@ -0,0 +1,5 @@
+const objectEntries = (obj) => Object.entries(obj);
+export {
+  objectEntries
+};
+//# sourceMappingURL=object-entries.js.map

package/dist/object/object-entries.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/object/object-entries.ts"],
+  "sourcesContent": ["/** Type safe version of Object.entries */\nexport const objectEntries = <T extends object>(obj: T): [keyof T, T[keyof T]][] =>\n  Object.entries(obj) as [keyof T, T[keyof T]][]\n"],
+  "mappings": "AACO,MAAM,gBAAgB,CAAmB,QAC9C,OAAO,QAAQ,GAAG;",
+  "names": []
+}

package/dist/regex/replace-variables.d.ts

@@ -1,5 +1,6 @@
 /**
- * This function takes a string and replace {variables} with given values.
+ * This function takes a string and replaces both {single} and {{double}} curly brace variables with given values.
+ * Use the replacePathVariables and replaceEnvVariables functions if you only need to replace one type of variable.
  */
 export declare function replaceVariables(value: string, variablesOrCallback: Record<string, string | number> | ((match: string) => string)): string;
 /** Replace {path} variables with their values */

package/dist/regex/replace-variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"replace-variables.d.ts","sourceRoot":"","sources":["../../src/regex/replace-variables.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,MAAM,EACb,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,UAenF;AAED,iDAAiD;AACjD,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,EAAE,YAAW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,WACtB,CAAA;AAEnE,kDAAkD;AAClD,eAAO,MAAM,mBAAmB,GAAI,MAAM,MAAM,EAAE,YAAW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,WAChB,CAAA"}
+{"version":3,"file":"replace-variables.d.ts","sourceRoot":"","sources":["../../src/regex/replace-variables.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,MAAM,EACb,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,UAenF;AAED,iDAAiD;AACjD,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,EAAE,YAAW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,WACtB,CAAA;AAEnE,kDAAkD;AAClD,eAAO,MAAM,mBAAmB,GAAI,MAAM,MAAM,EAAE,YAAW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,WAChB,CAAA"}

package/dist/regex/replace-variables.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/regex/replace-variables.ts"],
-  "sourcesContent": ["import { REGEX } from '@/regex/regex-helpers'\n\n/**\n * This function takes a string and replace {variables} with given values.\n */\nexport function replaceVariables(\n  value: string,\n  variablesOrCallback: Record<string, string | number> | ((match: string) => string),\n) {\n  // Replace all variables (example: {{ baseurl }} with an HTML tag)\n  const doubleCurlyBrackets = /{{\\s*([\\w.-]+)\\s*}}/g\n  const singleCurlyBrackets = /{\\s*([\\w.-]+)\\s*}/g\n\n  const callback = (_: string, match: string): string => {\n    if (typeof variablesOrCallback === 'function') {\n      return variablesOrCallback(match)\n    }\n    return variablesOrCallback[match]?.toString() || `{${match}}`\n  }\n\n  // Loop through all matches and replace the match with the variable value\n  return value.replace(doubleCurlyBrackets, callback).replace(singleCurlyBrackets, callback)\n}\n\n/** Replace {path} variables with their values */\nexport const replacePathVariables = (path: string, variables: Record<string, string> = {}) =>\n  path.replace(REGEX.PATH, (match, key) => variables[key] ?? match)\n\n/** Replace {{env}} variables with their values */\nexport const replaceEnvVariables = (path: string, variables: Record<string, string> = {}) =>\n  path.replace(REGEX.VARIABLES, (match, key) => variables[key] ?? match)\n"],
-  "mappings": "AAAA,SAAS,aAAa;AAKf,SAAS,iBACd,OACA,qBACA;AAEA,QAAM,sBAAsB;AAC5B,QAAM,sBAAsB;AAE5B,QAAM,WAAW,CAAC,GAAW,UAA0B;AACrD,QAAI,OAAO,wBAAwB,YAAY;AAC7C,aAAO,oBAAoB,KAAK;AAAA,IAClC;AACA,WAAO,oBAAoB,KAAK,GAAG,SAAS,KAAK,IAAI,KAAK;AAAA,EAC5D;AAGA,SAAO,MAAM,QAAQ,qBAAqB,QAAQ,EAAE,QAAQ,qBAAqB,QAAQ;AAC3F;AAGO,MAAM,uBAAuB,CAAC,MAAc,YAAoC,CAAC,MACtF,KAAK,QAAQ,MAAM,MAAM,CAAC,OAAO,QAAQ,UAAU,GAAG,KAAK,KAAK;AAG3D,MAAM,sBAAsB,CAAC,MAAc,YAAoC,CAAC,MACrF,KAAK,QAAQ,MAAM,WAAW,CAAC,OAAO,QAAQ,UAAU,GAAG,KAAK,KAAK;",
+  "sourcesContent": ["import { REGEX } from '@/regex/regex-helpers'\n\n/**\n * This function takes a string and replaces both {single} and {{double}} curly brace variables with given values.\n * Use the replacePathVariables and replaceEnvVariables functions if you only need to replace one type of variable.\n */\nexport function replaceVariables(\n  value: string,\n  variablesOrCallback: Record<string, string | number> | ((match: string) => string),\n) {\n  // Replace all variables (example: {{ baseurl }} with an HTML tag)\n  const doubleCurlyBrackets = /{{\\s*([\\w.-]+)\\s*}}/g\n  const singleCurlyBrackets = /{\\s*([\\w.-]+)\\s*}/g\n\n  const callback = (_: string, match: string): string => {\n    if (typeof variablesOrCallback === 'function') {\n      return variablesOrCallback(match)\n    }\n    return variablesOrCallback[match]?.toString() || `{${match}}`\n  }\n\n  // Loop through all matches and replace the match with the variable value\n  return value.replace(doubleCurlyBrackets, callback).replace(singleCurlyBrackets, callback)\n}\n\n/** Replace {path} variables with their values */\nexport const replacePathVariables = (path: string, variables: Record<string, string> = {}) =>\n  path.replace(REGEX.PATH, (match, key) => variables[key] ?? match)\n\n/** Replace {{env}} variables with their values */\nexport const replaceEnvVariables = (path: string, variables: Record<string, string> = {}) =>\n  path.replace(REGEX.VARIABLES, (match, key) => variables[key] ?? match)\n"],
+  "mappings": "AAAA,SAAS,aAAa;AAMf,SAAS,iBACd,OACA,qBACA;AAEA,QAAM,sBAAsB;AAC5B,QAAM,sBAAsB;AAE5B,QAAM,WAAW,CAAC,GAAW,UAA0B;AACrD,QAAI,OAAO,wBAAwB,YAAY;AAC7C,aAAO,oBAAoB,KAAK;AAAA,IAClC;AACA,WAAO,oBAAoB,KAAK,GAAG,SAAS,KAAK,IAAI,KAAK;AAAA,EAC5D;AAGA,SAAO,MAAM,QAAQ,qBAAqB,QAAQ,EAAE,QAAQ,qBAAqB,QAAQ;AAC3F;AAGO,MAAM,uBAAuB,CAAC,MAAc,YAAoC,CAAC,MACtF,KAAK,QAAQ,MAAM,MAAM,CAAC,OAAO,QAAQ,UAAU,GAAG,KAAK,KAAK;AAG3D,MAAM,sBAAsB,CAAC,MAAc,YAAoC,CAAC,MACrF,KAAK,QAAQ,MAAM,WAAW,CAAC,OAAO,QAAQ,UAAU,GAAG,KAAK,KAAK;",
   "names": []
 }

package/package.json

@@ -14,7 +14,7 @@
     "helpers",
     "js"
   ],
-  "version": "0.2.2",
+  "version": "0.2.5",
   "engines": {
     "node": ">=20"
   },
@@ -91,7 +91,7 @@
     "jsdom": "26.1.0",
     "vite": "7.1.11",
     "vitest": "3.2.4",
-    "@scalar/build-tooling": "0.3.1"
+    "@scalar/build-tooling": "0.4.1"
   },
   "scripts": {
     "build": "scalar-build-esbuild",