@strictly/define 0.0.11 → 0.0.13

package/.turbo/turbo-build.log

@@ -7,12 +7,12 @@ $ tsup
 CLI Target: es6
 CJS Build start
 ESM Build start
-CJS dist/index.cjs 30.58 KB
-CJS ⚡️ Build success in 76ms
-ESM dist/index.js 28.28 KB
-ESM ⚡️ Build success in 75ms
+CJS dist/index.cjs 31.10 KB
+CJS ⚡️ Build success in 55ms
+ESM dist/index.js 28.71 KB
+ESM ⚡️ Build success in 56ms
 DTS Build start
-DTS ⚡️ Build success in 5294ms
-DTS dist/index.d.cts 40.10 KB
-DTS dist/index.d.ts  40.10 KB
-Done in 6.13s.
+DTS ⚡️ Build success in 5419ms
+DTS dist/index.d.cts 40.77 KB
+DTS dist/index.d.ts  40.77 KB
+Done in 6.25s.

package/.turbo/turbo-check-types.log

@@ -1,3 +1,3 @@
 yarn run v1.22.22
 $ tsc
-Done in 4.62s.
+Done in 4.83s.

package/.turbo/turbo-release$colon$exports.log

@@ -1,3 +1,3 @@
 yarn run v1.22.22
 $ json -f package.json -f package.exports.json --merge > package.release.json
-Done in 0.08s.
+Done in 0.12s.

package/dist/index.cjs

@@ -59,6 +59,8 @@ __export(index_exports, {
   isFunctionalValidator: () => isFunctionalValidator,
   jsonPath: () => jsonPath,
   jsonPathPop: () => jsonPathPop,
+  jsonPathPrefix: () => jsonPathPrefix,
+  jsonPathUnprefix: () => jsonPathUnprefix,
   list: () => list,
   literal: () => literal,
   mergeAnnotations: () => mergeAnnotations,
@@ -220,15 +222,16 @@ function copy(t, proto) {
 }
 
 // transformers/copies/mobx_copy.ts
-var import_base3 = require("@strictly/base");
+var import_base4 = require("@strictly/base");
 var import_mobx = require("mobx");
 
 // transformers/flatteners/flatten_value_to.ts
-var import_base2 = require("@strictly/base");
+var import_base3 = require("@strictly/base");
 
 // transformers/flatteners/json_path.ts
-function jsonPath(prefix, segment, qualifier = "") {
-  const s = `.${qualifier}${segment}`;
+var import_base2 = require("@strictly/base");
+function jsonPath(prefix, segment, qualifier) {
+  const s = `.${qualifier != null ? qualifier : ""}${segment}`;
   return `${prefix}${s}`;
 }
 function jsonPathPop(path) {
@@ -241,6 +244,14 @@ function jsonPathPop(path) {
     parts.pop()
   ];
 }
+function jsonPathPrefix(prefix, path) {
+  (0, import_base2.assertEqual)(path[0], "$", "{} should start with $", path);
+  return `${prefix}${path.slice(1)}`;
+}
+function jsonPathUnprefix(prefix, path) {
+  (0, import_base2.assertState)(path.startsWith(prefix), "{} should start with {}", path, prefix);
+  return `$${path.slice(prefix.length)}`;
+}
 
 // transformers/flatteners/flatten_value_to.ts
 function flattenValueTo({ definition }, v, setter, mapper2) {
@@ -276,7 +287,7 @@ function internalFlattenValueChildren(valuePath, typePath, qualifier, typeDef, v
     case 5 /* Union */:
       return internalFlattenUnionChildren(valuePath, typePath, qualifier, typeDef, v, mapper2, r);
     default:
-      throw new import_base2.UnreachableError(typeDef);
+      throw new import_base3.UnreachableError(typeDef);
   }
 }
 function internalFlattenListChildren(valuePath, typePath, { elements }, v, mapper2, r) {
@@ -297,7 +308,7 @@ function internalFlattenListChildren(valuePath, typePath, { elements }, v, mappe
 }
 function internalFlattenRecordChildren(valuePath, typePath, { valueTypeDef }, v, mapper2, r) {
   const newTypePath = jsonPath(typePath, "*");
-  return (0, import_base2.reduce)(
+  return (0, import_base3.reduce)(
     v,
     function(r2, k, value) {
       return internalFlattenValue(
@@ -316,7 +327,7 @@ function internalFlattenRecordChildren(valuePath, typePath, { valueTypeDef }, v,
   );
 }
 function internalFlattenObjectChildren(valuePath, typePath, qualifier, { fields }, v, mapper2, r) {
-  return (0, import_base2.reduce)(
+  return (0, import_base3.reduce)(
     fields,
     function(r2, k, fieldTypeDef) {
       const fieldValue = v[k];
@@ -350,7 +361,7 @@ function internalFlattenUnionChildren(valuePath, typePath, qualifier, typeDef, v
 }
 function getUnionTypeDef(typeDef, v) {
   if (typeDef.discriminator == null) {
-    return (0, import_base2.reduce)(
+    return (0, import_base3.reduce)(
       typeDef.unions,
       function(acc, _k, t) {
         if (t.type === 1 /* Literal */ && t.valuePrototype) {
@@ -391,7 +402,7 @@ function observeValue(v, def) {
     case 4 /* Object */:
       return (0, import_mobx.makeObservable)(
         v,
-        (0, import_base3.reduce)(
+        (0, import_base4.reduce)(
           def.fields,
           function(acc, k) {
             acc[k] = import_mobx.observable;
@@ -407,7 +418,7 @@ function observeValue(v, def) {
     case 5 /* Union */:
       return observeValue(v, getUnionTypeDef(def, v));
     default:
-      throw new import_base3.UnreachableError(def);
+      throw new import_base4.UnreachableError(def);
   }
 }
 function mobxCopy(t, proto) {
@@ -445,10 +456,10 @@ function flattenJsonValueToTypePathsOf(t, value) {
 }
 
 // transformers/flatteners/flatten_type_to.ts
-var import_base4 = require("@strictly/base");
+var import_base5 = require("@strictly/base");
 function flattenTypeTo({ definition }, mapper2) {
   const typeDefs = internalFlattenTypeDef("$", definition, {});
-  return (0, import_base4.reduce)(
+  return (0, import_base5.reduce)(
     typeDefs,
     function(acc, key, typeDef) {
       acc[key] = mapper2(typeDef, key);
@@ -475,7 +486,7 @@ function internalFlattenTypeDefChildren(path, qualifier, t, r) {
     case 5 /* Union */:
       return internalFlattenUnionTypeDefChildren(path, qualifier, t, r);
     default:
-      throw new import_base4.UnreachableError(t);
+      throw new import_base5.UnreachableError(t);
   }
 }
 function internalFlattenedListTypeDefChildren(path, { elements }, r) {
@@ -485,7 +496,7 @@ function internalFlattenRecordTypeDefChildren(path, { valueTypeDef }, r) {
   return internalFlattenTypeDef(jsonPath(path, "*"), valueTypeDef, r);
 }
 function internalFlattenObjectTypeDefChildren(path, qualifier, { fields }, r) {
-  return (0, import_base4.reduce)(
+  return (0, import_base5.reduce)(
     fields,
     function(acc, fieldName, fieldTypeDef) {
       return internalFlattenTypeDef(
@@ -501,7 +512,7 @@ function internalFlattenUnionTypeDefChildren(path, qualifier, {
   discriminator,
   unions
 }, r) {
-  return (0, import_base4.reduce)(
+  return (0, import_base5.reduce)(
     unions,
     function(acc, key, typeDef) {
       return internalFlattenTypeDefChildren(
@@ -561,10 +572,10 @@ function flattenValuesOfType(typeDef, value) {
 }
 
 // transformers/flatteners/value_path_to_type_path.ts
-var import_base5 = require("@strictly/base");
+var import_base6 = require("@strictly/base");
 function valuePathToTypePath({ definition: typeDef }, valuePath, allowMissingPaths = false) {
   const valueSteps = valuePath.split(/\.|\[/g);
-  (0, import_base5.assertEqual)(valueSteps[0], "$");
+  (0, import_base6.assertEqual)(valueSteps[0], "$");
   const typeSteps = internalJsonValuePathToTypePath(
     typeDef,
     valueSteps.slice(1),
@@ -588,7 +599,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
       if (allowMissingPaths) {
         return valueSteps;
       } else {
-        throw new import_base5.PreconditionFailedError(
+        throw new import_base6.PreconditionFailedError(
           "literal should terminate path {} ({})",
           originalValuePath,
           valueStep
@@ -620,7 +631,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
           return valueSteps;
         }
       } else {
-        (0, import_base5.assertExists)(typeDef.fields[valueStep], "missing field in {} ({})", originalValuePath, valueStep);
+        (0, import_base6.assertExists)(typeDef.fields[valueStep], "missing field in {} ({})", originalValuePath, valueStep);
       }
       return [
         valueStep,
@@ -634,7 +645,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
     case 5 /* Union */:
       if (typeDef.discriminator == null) {
         if (remainingValueSteps.length > 0) {
-          const union2 = (0, import_base5.reduce)(
+          const union2 = (0, import_base6.reduce)(
             typeDef.unions,
             function(acc, _k, v) {
               if (v.type !== 1 /* Literal */ || v.type === 1 /* Literal */ && v.valuePrototype == null) {
@@ -644,7 +655,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
             },
             null
           );
-          (0, import_base5.assertExists)(union2, "expected a complex union {}", originalValuePath);
+          (0, import_base6.assertExists)(union2, "expected a complex union {}", originalValuePath);
           return internalJsonValuePathToTypePath(
             union2,
             valueSteps,
@@ -660,7 +671,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
           if (allowMissingPaths) {
             return valueSteps;
           } else {
-            throw new import_base5.PreconditionFailedError(
+            throw new import_base6.PreconditionFailedError(
               "mismatched qualifiers in {} (at {})",
               originalValuePath,
               valueStep
@@ -669,7 +680,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
         }
         const qualifier = valueStep.substring(0, qualifierIndex);
         const remainder = valueStep.substring(qualifierIndex + 1);
-        const union2 = (0, import_base5.assertExistsAndReturn)(typeDef.unions[qualifier], "missing union {}", qualifier);
+        const union2 = (0, import_base6.assertExistsAndReturn)(typeDef.unions[qualifier], "missing union {}", qualifier);
         const [
           typeStep,
           ...remainingTypeSteps
@@ -688,7 +699,7 @@ function internalJsonValuePathToTypePath(typeDef, valueSteps, allowMissingPaths,
         ];
       }
     default:
-      throw new import_base5.UnreachableError(typeDef);
+      throw new import_base6.UnreachableError(typeDef);
   }
 }
 
@@ -724,7 +735,7 @@ function mergeAnnotations(a1, a2) {
 }
 
 // types/type_of_type.ts
-var import_base6 = require("@strictly/base");
+var import_base7 = require("@strictly/base");
 function typeOfType({ definition }) {
   return {
     definition: typeDefOfTypeDef(definition)
@@ -743,7 +754,7 @@ function typeDefOfTypeDef(t) {
     case 5 /* Union */:
       return typeDefOfUnionTypeDef(t);
     default:
-      throw new import_base6.UnreachableError(t);
+      throw new import_base7.UnreachableError(t);
   }
 }
 function typeDefOfLiteralTypeDef({
@@ -781,7 +792,7 @@ function typeDefOfObjectTypeDef({
 }) {
   return {
     type,
-    fields: (0, import_base6.map)(fields, function(_k, v) {
+    fields: (0, import_base7.map)(fields, function(_k, v) {
       return typeDefOfTypeDef(v);
     })
   };
@@ -794,7 +805,7 @@ function typeDefOfUnionTypeDef({
   return {
     type,
     discriminator,
-    unions: (0, import_base6.map)(unions, function(_k, v) {
+    unions: (0, import_base7.map)(unions, function(_k, v) {
       return typeDefOfTypeDef(v);
     })
   };
@@ -1137,6 +1148,8 @@ var RegexpValidator = _RegexpValidator;
   isFunctionalValidator,
   jsonPath,
   jsonPathPop,
+  jsonPathPrefix,
+  jsonPathUnprefix,
   list,
   literal,
   mergeAnnotations,

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { IsEqual, Simplify, UnionToIntersection, SimplifyDeep } from 'type-fest';
-import { IsFieldReadonly } from '@strictly/base';
+import { IsFieldReadonly, StringConcatOf } from '@strictly/base';
 
 type Type<T extends TypeDef = TypeDef> = {
     readonly definition: T;
@@ -298,8 +298,11 @@ declare function flattenValidatorsOfValidatingType<T extends ValidatingType, Typ
 
 declare function flattenValuesOfType<T extends Type>(typeDef: Type, value: ValueOfType<T>): Readonly<Record<string, any>>;
 
-declare function jsonPath(prefix: string, segment: number | string, qualifier?: string): string;
-declare function jsonPathPop(path: string): [string, string] | null;
+declare function jsonPath<Prefix extends string, Segment extends number | string>(prefix: Prefix, segment: Segment): `${Prefix}.${Segment}`;
+declare function jsonPath<Prefix extends string, Segment extends number | string, Qualifier extends string>(prefix: Prefix, segment: Segment, qualifier: Qualifier): `${Prefix}.${Qualifier}${Segment}`;
+declare function jsonPathPop<Path extends string>(path: Path): [string, string] | null;
+declare function jsonPathPrefix<Prefix extends string, Path extends string>(prefix: Prefix, path: Path): Path extends StringConcatOf<'$', infer ToMount> ? `${Prefix}${ToMount}` : never;
+declare function jsonPathUnprefix<Prefix extends string, Path extends string>(prefix: Prefix, path: Path): Path extends StringConcatOf<Prefix, infer ToUnmount> ? `$${ToUnmount}` : never;
 
 declare function valuePathToTypePath<ValuePathsToTypePaths extends Record<string, string>, ValuePath extends keyof ValuePathsToTypePaths>({ definition: typeDef }: Type, valuePath: ValuePath, allowMissingPaths?: boolean): ValuePathsToTypePaths[ValuePath];
 
@@ -592,4 +595,4 @@ type ValidatorsOfValues<FlattenedValues extends Readonly<Record<string, any>>, T
     readonly [K in keyof FlattenedValues]: Validator<FlattenedValues[K], any, TypePathsToValuePaths[K], Context>;
 };
 
-export { type Accessor, type AnnotatedValidator, type Annotations, type AnyValueType, DefinedValidator, type ErrorOfValidator, type FlattenedAccessorsOfType, type FlattenedTypesOfType, type FlattenedValuesOfType, type FunctionalValidator, type InternalJsonPathsOf, type IsStrictUnion, type ListTypeDef, type LiteralTypeDef, type Mapper, type MinimumStringLengthValidationError, MinimumStringLengthValidationErrorType, MinimumStringLengthValidator, type MobxObservable, type MobxValueOfType, type NonMobxObservable, type ObjectFieldKey, type ObjectTypeDef, type ObjectTypeDefFields, OptionalValidatorProxy, type PathsOfType, type ReadonlyOfTypeDef, type ReadonlyTypeOfType, type RecordKeyType, type RecordTypeDef, type RegexpValidationError, RegexpValidationErrorType, RegexpValidator, type Setter, type StrictListTypeDef, type StrictLiteralTypeDef, type StrictObjectTypeDef, type StrictObjectTypeDefFields, type StrictRecordTypeDef, type StrictType, type StrictTypeDef, type StrictUnionTypeDef, type Type, type TypeDef, TypeDefType, type UnionKey, type UnionTypeDef, type ValidationError, type Validator, type ValidatorsOfValues, type ValueOfType, type ValueOfTypeDef, type ValueToTypePathsOfType, type ValueTypesOfDiscriminatedUnion, annotations, booleanType, copy, flattenAccessorsOfType, flattenJsonValueToTypePathsOf, flattenTypesOfType, flattenValidatorsOfValidatingType, flattenValueTo, flattenValuesOfType, getUnionTypeDef, isAnnotatedValidator, isFunctionalValidator, jsonPath, jsonPathPop, list, literal, mergeAnnotations, mobxCopy, nullType, nullable, numberType, object, record, stringType, union, validate, valuePathToTypePath };
+export { type Accessor, type AnnotatedValidator, type Annotations, type AnyValueType, DefinedValidator, type ErrorOfValidator, type FlattenedAccessorsOfType, type FlattenedTypesOfType, type FlattenedValuesOfType, type FunctionalValidator, type InternalJsonPathsOf, type IsStrictUnion, type ListTypeDef, type LiteralTypeDef, type Mapper, type MinimumStringLengthValidationError, MinimumStringLengthValidationErrorType, MinimumStringLengthValidator, type MobxObservable, type MobxValueOfType, type NonMobxObservable, type ObjectFieldKey, type ObjectTypeDef, type ObjectTypeDefFields, OptionalValidatorProxy, type PathsOfType, type ReadonlyOfTypeDef, type ReadonlyTypeOfType, type RecordKeyType, type RecordTypeDef, type RegexpValidationError, RegexpValidationErrorType, RegexpValidator, type Setter, type StrictListTypeDef, type StrictLiteralTypeDef, type StrictObjectTypeDef, type StrictObjectTypeDefFields, type StrictRecordTypeDef, type StrictType, type StrictTypeDef, type StrictUnionTypeDef, type Type, type TypeDef, TypeDefType, type UnionKey, type UnionTypeDef, type ValidationError, type Validator, type ValidatorsOfValues, type ValueOfType, type ValueOfTypeDef, type ValueToTypePathsOfType, type ValueTypesOfDiscriminatedUnion, annotations, booleanType, copy, flattenAccessorsOfType, flattenJsonValueToTypePathsOf, flattenTypesOfType, flattenValidatorsOfValidatingType, flattenValueTo, flattenValuesOfType, getUnionTypeDef, isAnnotatedValidator, isFunctionalValidator, jsonPath, jsonPathPop, jsonPathPrefix, jsonPathUnprefix, list, literal, mergeAnnotations, mobxCopy, nullType, nullable, numberType, object, record, stringType, union, validate, valuePathToTypePath };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { IsEqual, Simplify, UnionToIntersection, SimplifyDeep } from 'type-fest';
-import { IsFieldReadonly } from '@strictly/base';
+import { IsFieldReadonly, StringConcatOf } from '@strictly/base';
 
 type Type<T extends TypeDef = TypeDef> = {
     readonly definition: T;
@@ -298,8 +298,11 @@ declare function flattenValidatorsOfValidatingType<T extends ValidatingType, Typ
 
 declare function flattenValuesOfType<T extends Type>(typeDef: Type, value: ValueOfType<T>): Readonly<Record<string, any>>;
 
-declare function jsonPath(prefix: string, segment: number | string, qualifier?: string): string;
-declare function jsonPathPop(path: string): [string, string] | null;
+declare function jsonPath<Prefix extends string, Segment extends number | string>(prefix: Prefix, segment: Segment): `${Prefix}.${Segment}`;
+declare function jsonPath<Prefix extends string, Segment extends number | string, Qualifier extends string>(prefix: Prefix, segment: Segment, qualifier: Qualifier): `${Prefix}.${Qualifier}${Segment}`;
+declare function jsonPathPop<Path extends string>(path: Path): [string, string] | null;
+declare function jsonPathPrefix<Prefix extends string, Path extends string>(prefix: Prefix, path: Path): Path extends StringConcatOf<'$', infer ToMount> ? `${Prefix}${ToMount}` : never;
+declare function jsonPathUnprefix<Prefix extends string, Path extends string>(prefix: Prefix, path: Path): Path extends StringConcatOf<Prefix, infer ToUnmount> ? `$${ToUnmount}` : never;
 
 declare function valuePathToTypePath<ValuePathsToTypePaths extends Record<string, string>, ValuePath extends keyof ValuePathsToTypePaths>({ definition: typeDef }: Type, valuePath: ValuePath, allowMissingPaths?: boolean): ValuePathsToTypePaths[ValuePath];
 
@@ -592,4 +595,4 @@ type ValidatorsOfValues<FlattenedValues extends Readonly<Record<string, any>>, T
     readonly [K in keyof FlattenedValues]: Validator<FlattenedValues[K], any, TypePathsToValuePaths[K], Context>;
 };
 
-export { type Accessor, type AnnotatedValidator, type Annotations, type AnyValueType, DefinedValidator, type ErrorOfValidator, type FlattenedAccessorsOfType, type FlattenedTypesOfType, type FlattenedValuesOfType, type FunctionalValidator, type InternalJsonPathsOf, type IsStrictUnion, type ListTypeDef, type LiteralTypeDef, type Mapper, type MinimumStringLengthValidationError, MinimumStringLengthValidationErrorType, MinimumStringLengthValidator, type MobxObservable, type MobxValueOfType, type NonMobxObservable, type ObjectFieldKey, type ObjectTypeDef, type ObjectTypeDefFields, OptionalValidatorProxy, type PathsOfType, type ReadonlyOfTypeDef, type ReadonlyTypeOfType, type RecordKeyType, type RecordTypeDef, type RegexpValidationError, RegexpValidationErrorType, RegexpValidator, type Setter, type StrictListTypeDef, type StrictLiteralTypeDef, type StrictObjectTypeDef, type StrictObjectTypeDefFields, type StrictRecordTypeDef, type StrictType, type StrictTypeDef, type StrictUnionTypeDef, type Type, type TypeDef, TypeDefType, type UnionKey, type UnionTypeDef, type ValidationError, type Validator, type ValidatorsOfValues, type ValueOfType, type ValueOfTypeDef, type ValueToTypePathsOfType, type ValueTypesOfDiscriminatedUnion, annotations, booleanType, copy, flattenAccessorsOfType, flattenJsonValueToTypePathsOf, flattenTypesOfType, flattenValidatorsOfValidatingType, flattenValueTo, flattenValuesOfType, getUnionTypeDef, isAnnotatedValidator, isFunctionalValidator, jsonPath, jsonPathPop, list, literal, mergeAnnotations, mobxCopy, nullType, nullable, numberType, object, record, stringType, union, validate, valuePathToTypePath };
+export { type Accessor, type AnnotatedValidator, type Annotations, type AnyValueType, DefinedValidator, type ErrorOfValidator, type FlattenedAccessorsOfType, type FlattenedTypesOfType, type FlattenedValuesOfType, type FunctionalValidator, type InternalJsonPathsOf, type IsStrictUnion, type ListTypeDef, type LiteralTypeDef, type Mapper, type MinimumStringLengthValidationError, MinimumStringLengthValidationErrorType, MinimumStringLengthValidator, type MobxObservable, type MobxValueOfType, type NonMobxObservable, type ObjectFieldKey, type ObjectTypeDef, type ObjectTypeDefFields, OptionalValidatorProxy, type PathsOfType, type ReadonlyOfTypeDef, type ReadonlyTypeOfType, type RecordKeyType, type RecordTypeDef, type RegexpValidationError, RegexpValidationErrorType, RegexpValidator, type Setter, type StrictListTypeDef, type StrictLiteralTypeDef, type StrictObjectTypeDef, type StrictObjectTypeDefFields, type StrictRecordTypeDef, type StrictType, type StrictTypeDef, type StrictUnionTypeDef, type Type, type TypeDef, TypeDefType, type UnionKey, type UnionTypeDef, type ValidationError, type Validator, type ValidatorsOfValues, type ValueOfType, type ValueOfTypeDef, type ValueToTypePathsOfType, type ValueTypesOfDiscriminatedUnion, annotations, booleanType, copy, flattenAccessorsOfType, flattenJsonValueToTypePathsOf, flattenTypesOfType, flattenValidatorsOfValidatingType, flattenValueTo, flattenValuesOfType, getUnionTypeDef, isAnnotatedValidator, isFunctionalValidator, jsonPath, jsonPathPop, jsonPathPrefix, jsonPathUnprefix, list, literal, mergeAnnotations, mobxCopy, nullType, nullable, numberType, object, record, stringType, union, validate, valuePathToTypePath };

package/dist/index.js

@@ -185,8 +185,12 @@ import {
 } from "@strictly/base";
 
 // transformers/flatteners/json_path.ts
-function jsonPath(prefix, segment, qualifier = "") {
-  const s = `.${qualifier}${segment}`;
+import {
+  assertEqual,
+  assertState
+} from "@strictly/base";
+function jsonPath(prefix, segment, qualifier) {
+  const s = `.${qualifier != null ? qualifier : ""}${segment}`;
   return `${prefix}${s}`;
 }
 function jsonPathPop(path) {
@@ -199,6 +203,14 @@ function jsonPathPop(path) {
     parts.pop()
   ];
 }
+function jsonPathPrefix(prefix, path) {
+  assertEqual(path[0], "$", "{} should start with $", path);
+  return `${prefix}${path.slice(1)}`;
+}
+function jsonPathUnprefix(prefix, path) {
+  assertState(path.startsWith(prefix), "{} should start with {}", path, prefix);
+  return `$${path.slice(prefix.length)}`;
+}
 
 // transformers/flatteners/flatten_value_to.ts
 function flattenValueTo({ definition }, v, setter, mapper2) {
@@ -523,7 +535,7 @@ function flattenValuesOfType(typeDef, value) {
 
 // transformers/flatteners/value_path_to_type_path.ts
 import {
-  assertEqual,
+  assertEqual as assertEqual2,
   assertExists,
   assertExistsAndReturn,
   PreconditionFailedError,
@@ -532,7 +544,7 @@ import {
 } from "@strictly/base";
 function valuePathToTypePath({ definition: typeDef }, valuePath, allowMissingPaths = false) {
   const valueSteps = valuePath.split(/\.|\[/g);
-  assertEqual(valueSteps[0], "$");
+  assertEqual2(valueSteps[0], "$");
   const typeSteps = internalJsonValuePathToTypePath(
     typeDef,
     valueSteps.slice(1),
@@ -1107,6 +1119,8 @@ export {
   isFunctionalValidator,
   jsonPath,
   jsonPathPop,
+  jsonPathPrefix,
+  jsonPathUnprefix,
   list,
   literal,
   mergeAnnotations,

package/package.json

@@ -35,7 +35,7 @@
     "test:watch": "vitest"
   },
   "type": "module",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "exports": {
     ".": {
       "import": {

package/transformers/flatteners/json_path.ts

@@ -1,9 +1,30 @@
-export function jsonPath(prefix: string, segment: number | string, qualifier: string = ''): string {
-  const s = `.${qualifier}${segment}`
-  return `${prefix}${s}`
+import {
+  assertEqual,
+  assertState,
+  type StringConcatOf,
+} from '@strictly/base'
+
+export function jsonPath<
+  Prefix extends string,
+  Segment extends number | string,
+>(prefix: Prefix, segment: Segment): `${Prefix}.${Segment}`
+export function jsonPath<
+  Prefix extends string,
+  Segment extends number | string,
+  Qualifier extends string,
+>(prefix: Prefix, segment: Segment, qualifier: Qualifier): `${Prefix}.${Qualifier}${Segment}`
+export function jsonPath<
+  Prefix extends string,
+  Segment extends number | string,
+  Qualifier extends string = '',
+>(prefix: Prefix, segment: Segment, qualifier?: Qualifier) {
+  const s = `.${qualifier ?? ''}${segment}`
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return `${prefix}${s}` as `${Prefix}.${Qualifier}${Segment}`
 }
 
-export function jsonPathPop(path: string): [string, string] | null {
+// TODO type safety
+export function jsonPathPop<Path extends string>(path: Path): [string, string] | null {
   const parts = path.split('.')
   if (parts.length <= 1) {
     return null
@@ -13,3 +34,22 @@ export function jsonPathPop(path: string): [string, string] | null {
     parts.pop()!,
   ]
 }
+
+export function jsonPathPrefix<
+  Prefix extends string,
+  Path extends string,
+>(prefix: Prefix, path: Path): Path extends StringConcatOf<'$', infer ToMount> ? `${Prefix}${ToMount}` : never {
+  assertEqual(path[0], '$', '{} should start with $', path)
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return `${prefix}${path.slice(1)}` as Path extends StringConcatOf<'$', infer ToMount> ? `${Prefix}${ToMount}` : never
+}
+
+export function jsonPathUnprefix<
+  Prefix extends string,
+  Path extends string,
+>(prefix: Prefix, path: Path): Path extends StringConcatOf<Prefix, infer ToUnmount> ? `$${ToUnmount}` : never {
+  assertState(path.startsWith(prefix), '{} should start with {}', path, prefix)
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return `$${path.slice(prefix.length)}` as Path extends StringConcatOf<Prefix, infer ToUnmount> ? `$${ToUnmount}`
+    : never
+}

package/transformers/flatteners/specs/json_paths.tests.ts

@@ -0,0 +1,69 @@
+import {
+  jsonPath,
+  jsonPathPrefix,
+  jsonPathUnprefix,
+} from 'transformers/flatteners/json_path'
+
+describe('json_paths', () => {
+  describe('jsonPath', () => {
+    describe('simple', () => {
+      const path = jsonPath('$', 'thing')
+
+      it('has the expected type', () => {
+        expectTypeOf(path).toEqualTypeOf<'$.thing'>()
+      })
+
+      it('has the expected value', () => {
+        expect(path).toEqual('$.thing')
+      })
+    })
+
+    describe('indexed', () => {
+      const path = jsonPath<`$.${number}`, number>(`$.${1}`, 1)
+
+      it('has the expected type', () => {
+        expectTypeOf(path).toEqualTypeOf<`$.${number}.${number}`>()
+      })
+
+      it('has the expected value', () => {
+        expect(path).toEqual('$.1.1')
+      })
+    })
+
+    describe('qualified', () => {
+      const path = jsonPath('$', 'x', 'y:')
+
+      it('has the expected type', () => {
+        expectTypeOf(path).toEqualTypeOf<'$.y:x'>()
+      })
+
+      it('has the expected value', () => {
+        expect(path).toEqual('$.y:x')
+      })
+    })
+  })
+
+  describe('jsonPathPrefix', () => {
+    const path = jsonPathPrefix('$.x', '$.x.y')
+
+    it('has the expected type', () => {
+      expectTypeOf(path).toEqualTypeOf<'$.x.x.y'>()
+    })
+
+    it('has the expected value', () => {
+      expect(path).toEqual('$.x.x.y')
+    })
+  })
+
+  describe('jsonPathUnprefix', () => {
+    const path = jsonPathUnprefix('$.x.x.x', '$.x.x.x.x.y')
+
+    it('has the expected type', () => {
+      expectTypeOf(path).toEqualTypeOf<'$.x.y'>()
+    })
+
+    it('has the expected value', () => {
+      expect(path).toEqual('$.x.y')
+    })
+  })
+})