@scalar/helpers 0.1.3 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/helpers
 
+## 0.2.1
+
+### Patch Changes
+
+- [#7489](https://github.com/scalar/scalar/pull/7489) [`21aa62e`](https://github.com/scalar/scalar/commit/21aa62e2ebdd262cb5aa53658c3b659736660722) Thanks [@amritk](https://github.com/amritk)! - feat: added new helpers for building client v2 requests
+
+## 0.2.0
+
+### Minor Changes
+
+- [#7477](https://github.com/scalar/scalar/pull/7477) [`9ec8adf`](https://github.com/scalar/scalar/commit/9ec8adfea017333dee5bc3949104232f7dc57f4a) Thanks [@DemonHa](https://github.com/DemonHa)! - fix: correctly sort documents on the workspace
+
 ## 0.1.3
 
 ### Patch Changes

package/dist/array/sort-by-order.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Immutably sorts an array based on a given custom order, as specified by a separate list of identifiers.
+ *
+ * Note: Make sure that the identifier is unique for each item in the array.
+ * If the identifier is not unique, only the last occurrence of the identifier will be sorted.
+ * Any other elements will be overridden by the last occurrence of the identifier.
+ *
+ * This function efficiently arranges elements of an input array so that items whose IDs (obtained via the `getId` callback)
+ * match the order array will appear first, strictly in the order specified. Items not found in the order array will be
+ * appended after, maintaining their original order.
+ *
+ * This is a flexible utility: the identifier can be extracted from any data structure via the `getId` callback,
+ * and any primitive (string, number, symbol, etc.) can serve as the identifier type.
+ * Sorting is O(n) with respect to the array size, making it performant even for large arrays.
+ *
+ * @template T - The type of array elements.
+ * @template N - The type of values in the order array and the identifier returned by the getId callback.
+ * @param arr - The array to be sorted.
+ * @param order - Array specifying the desired sequence (contains identifiers returned by getId).
+ * @param getId - A callback to extract the unique identifier from each array element.
+ * @returns A new array sorted according to the order provided, with unmatched elements following.
+ *
+ * @example
+ * // Sorting an array of objects:
+ * const items = [
+ *   { id: 'a', name: 'Alpha' },
+ *   { id: 'b', name: 'Bravo' },
+ *   { id: 'c', name: 'Charlie' }
+ * ];
+ * const order = ['c', 'a'];
+ * const sorted = sortByOrder(items, order, item => item.id);
+ * // Result:
+ * // [
+ * //   { id: 'c', name: 'Charlie' },
+ * //   { id: 'a', name: 'Alpha' },
+ * //   { id: 'b', name: 'Bravo' }
+ * // ]
+ *
+ * @example
+ * // Sorting an array of primitive values:
+ * const input = ['a', 'b', 'c', 'd'];
+ * const order = ['c', 'a'];
+ * sortByOrder(input, order, item => item);
+ * // Result: ['c', 'a', 'b', 'd']
+ */
+export declare function sortByOrder<T, N>(arr: T[], order: N[], getId: (item: T) => N): T[];
+//# sourceMappingURL=sort-by-order.d.ts.map

package/dist/array/sort-by-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-by-order.d.ts","sourceRoot":"","sources":["../../src/array/sort-by-order.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAkBlF"}

package/dist/array/sort-by-order.js

@@ -0,0 +1,19 @@
+function sortByOrder(arr, order, getId) {
+  const orderMap = /* @__PURE__ */ new Map();
+  order.forEach((e, idx) => orderMap.set(e, idx));
+  const sorted = [];
+  const untagged = [];
+  arr.forEach((e) => {
+    const sortedIdx = orderMap.get(getId(e));
+    if (sortedIdx === void 0) {
+      untagged.push(e);
+      return;
+    }
+    sorted[sortedIdx] = e;
+  });
+  return [...sorted.filter((it) => it !== void 0), ...untagged];
+}
+export {
+  sortByOrder
+};
+//# sourceMappingURL=sort-by-order.js.map

package/dist/array/sort-by-order.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/array/sort-by-order.ts"],
+  "sourcesContent": ["/**\n * Immutably sorts an array based on a given custom order, as specified by a separate list of identifiers.\n *\n * Note: Make sure that the identifier is unique for each item in the array.\n * If the identifier is not unique, only the last occurrence of the identifier will be sorted.\n * Any other elements will be overridden by the last occurrence of the identifier.\n *\n * This function efficiently arranges elements of an input array so that items whose IDs (obtained via the `getId` callback)\n * match the order array will appear first, strictly in the order specified. Items not found in the order array will be\n * appended after, maintaining their original order.\n *\n * This is a flexible utility: the identifier can be extracted from any data structure via the `getId` callback,\n * and any primitive (string, number, symbol, etc.) can serve as the identifier type.\n * Sorting is O(n) with respect to the array size, making it performant even for large arrays.\n *\n * @template T - The type of array elements.\n * @template N - The type of values in the order array and the identifier returned by the getId callback.\n * @param arr - The array to be sorted.\n * @param order - Array specifying the desired sequence (contains identifiers returned by getId).\n * @param getId - A callback to extract the unique identifier from each array element.\n * @returns A new array sorted according to the order provided, with unmatched elements following.\n *\n * @example\n * // Sorting an array of objects:\n * const items = [\n *   { id: 'a', name: 'Alpha' },\n *   { id: 'b', name: 'Bravo' },\n *   { id: 'c', name: 'Charlie' }\n * ];\n * const order = ['c', 'a'];\n * const sorted = sortByOrder(items, order, item => item.id);\n * // Result:\n * // [\n * //   { id: 'c', name: 'Charlie' },\n * //   { id: 'a', name: 'Alpha' },\n * //   { id: 'b', name: 'Bravo' }\n * // ]\n *\n * @example\n * // Sorting an array of primitive values:\n * const input = ['a', 'b', 'c', 'd'];\n * const order = ['c', 'a'];\n * sortByOrder(input, order, item => item);\n * // Result: ['c', 'a', 'b', 'd']\n */\nexport function sortByOrder<T, N>(arr: T[], order: N[], getId: (item: T) => N): T[] {\n  // Map the order to keep a single lookup table\n  const orderMap = new Map<N, number>()\n  order.forEach((e, idx) => orderMap.set(e, idx))\n\n  const sorted: T[] = []\n  const untagged: T[] = []\n\n  arr.forEach((e) => {\n    const sortedIdx = orderMap.get(getId(e))\n    if (sortedIdx === undefined) {\n      untagged.push(e)\n      return\n    }\n    sorted[sortedIdx] = e\n  })\n\n  return [...sorted.filter((it) => it !== undefined), ...untagged]\n}\n"],
+  "mappings": "AA6CO,SAAS,YAAkB,KAAU,OAAY,OAA4B;AAElF,QAAM,WAAW,oBAAI,IAAe;AACpC,QAAM,QAAQ,CAAC,GAAG,QAAQ,SAAS,IAAI,GAAG,GAAG,CAAC;AAE9C,QAAM,SAAc,CAAC;AACrB,QAAM,WAAgB,CAAC;AAEvB,MAAI,QAAQ,CAAC,MAAM;AACjB,UAAM,YAAY,SAAS,IAAI,MAAM,CAAC,CAAC;AACvC,QAAI,cAAc,QAAW;AAC3B,eAAS,KAAK,CAAC;AACf;AAAA,IACF;AACA,WAAO,SAAS,IAAI;AAAA,EACtB,CAAC;AAED,SAAO,CAAC,GAAG,OAAO,OAAO,CAAC,OAAO,OAAO,MAAS,GAAG,GAAG,QAAQ;AACjE;",
+  "names": []
+}

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

@@ -2,4 +2,8 @@
  * This function takes a string and replace {variables} with given values.
  */
 export declare function replaceVariables(value: string, variablesOrCallback: Record<string, string | number> | ((match: string) => string)): string;
+/** Replace {path} variables with their values */
+export declare const replacePathVariables: (path: string, variables?: Record<string, string>) => string;
+/** Replace {{env}} variables with their values */
+export declare const replaceEnvVariables: (path: string, variables?: Record<string, string>) => string;
 //# sourceMappingURL=replace-variables.d.ts.map

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":"AAAA;;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"}
+{"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"}

package/dist/regex/replace-variables.js

@@ -1,3 +1,4 @@
+import { REGEX } from "../regex/regex-helpers.js";
 function replaceVariables(value, variablesOrCallback) {
   const doubleCurlyBrackets = /{{\s*([\w.-]+)\s*}}/g;
   const singleCurlyBrackets = /{\s*([\w.-]+)\s*}/g;
@@ -9,7 +10,11 @@ function replaceVariables(value, variablesOrCallback) {
   };
   return value.replace(doubleCurlyBrackets, callback).replace(singleCurlyBrackets, callback);
 }
+const replacePathVariables = (path, variables = {}) => path.replace(REGEX.PATH, (match, key) => variables[key] ?? match);
+const replaceEnvVariables = (path, variables = {}) => path.replace(REGEX.VARIABLES, (match, key) => variables[key] ?? match);
 export {
+  replaceEnvVariables,
+  replacePathVariables,
   replaceVariables
 };
 //# sourceMappingURL=replace-variables.js.map

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/regex/replace-variables.ts"],
-  "sourcesContent": ["/**\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"],
-  "mappings": "AAGO,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;",
+  "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;",
   "names": []
 }

package/package.json

@@ -14,7 +14,7 @@
     "helpers",
     "js"
   ],
-  "version": "0.1.3",
+  "version": "0.2.1",
   "engines": {
     "node": ">=20"
   },