@seedprotocol/eas 0.7.4-next.784.g879c6a3 → 0.7.4

package/dist/easNames.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Names on EAS (ADR 0008).
+ *
+ * Writing: {@link easName} is the only function that turns a local model or property name into an
+ * EAS name (`HTMLPage` → `html_page`). Everything that registers, attests or looks up a schema by
+ * name uses it.
+ *
+ * Reading: an EAS name is never turned back into a local name. It is matched against the local
+ * candidates by key, at a {@link NameMatchLevel}:
+ *
+ * - `exact`: `easName(local) === easName(eas)`.
+ * - `normalized`: lowercase alphanumerics only. `html_page`, `htmlpage`, `HTMLPage` and
+ *   `html-page` are the same; this finds seeds published under older SDKs' names.
+ * - `fuzzy`: the normalized key without a trailing plural `s`, and for relations without a
+ *   trailing `id`/`ids`. `posts` matches `post`, `author_id` matches the relation `author`.
+ *   No edit distance: `title` never matches `tile`.
+ *
+ * The tightest tier wins; a tie in the best tier matches nothing.
+ */
+/**
+ * The EAS name of a local model or property name: words split at lowercase-or-digit to uppercase
+ * boundaries and before the last capital of an acronym, every other run of non-alphanumerics
+ * turned into `_`, trimmed, lowercased.
+ * `HTMLPage → html_page`, `ID3Tag → id3_tag`, `imageV2 → image_v2`, `New model → new_model`.
+ */
+export declare const easName: (name: string) => string;
+export type NameMatchLevel = 'exact' | 'normalized' | 'fuzzy';
+/** How closely two names matched: the tightest level that accepts them. */
+export type NameMatchTier = NameMatchLevel;
+/** The default level (ADR 0008 and the nameMatch design): fuzzy. */
+export declare const DEFAULT_NAME_MATCH_LEVEL: NameMatchLevel;
+/** Lowercase alphanumerics only. */
+export declare const normalizedNameKey: (name: string) => string;
+/**
+ * The normalized key without a relation's trailing `ids`/`id` (when `relation`), then without a
+ * trailing plural `s`. Short keys are left alone, so `ids` and `bus` stay themselves.
+ */
+export declare const fuzzyNameKey: (name: string, options?: {
+    relation?: boolean;
+}) => string;
+/**
+ * The tightest tier at which a local name and a name from EAS match, or undefined. `relation`
+ * says whether the local name is a relation (Relation, Image, File, Html, or a List of them).
+ */
+export declare function nameMatchTier(localName: string, name: string, options?: {
+    relation?: boolean;
+}): NameMatchTier | undefined;
+export declare const isNameMatchAllowed: (tier: NameMatchTier, level: NameMatchLevel) => boolean;
+export declare const compareNameMatchTiers: (a: NameMatchTier, b: NameMatchTier) => number;
+export type NameMatchCandidate<T> = {
+    value: T;
+    /** The local name as it is written to EAS (a list relation's storage name, for instance). */
+    name: string;
+    relation?: boolean;
+    /** This candidate's level. Default {@link DEFAULT_NAME_MATCH_LEVEL}. */
+    level?: NameMatchLevel;
+};
+export type NameMatchResult<T> = {
+    kind: 'match';
+    value: T;
+    tier: NameMatchTier;
+} | {
+    kind: 'ambiguous';
+    values: T[];
+    tier: NameMatchTier;
+} | {
+    kind: 'none';
+};
+/**
+ * The candidate an EAS name matches: the one in the tightest tier its own level allows. Several
+ * candidates in that tier are ambiguous, and match nothing.
+ */
+export declare function matchEasName<T>(name: string, candidates: readonly NameMatchCandidate<T>[]): NameMatchResult<T>;
+/**
+ * The local names an EAS name matches in the tightest tier that has any (each name at `level`).
+ * Several names can share a tier, e.g. `New model` and `NewModel` for `new_model`: the caller
+ * decides whether that's ambiguous (models in different schemas) or the same thing.
+ */
+export declare function localNamesInBestMatchTier(name: string, localNames: Iterable<string>, options?: {
+    relation?: boolean;
+    level?: NameMatchLevel;
+}): Set<string>;
+/**
+ * Names that can match `name` at the normalized level and that an SDK may have written: its EAS
+ * name, and what older SDKs published (the simple snake_case: `HTMLPage` → `htmlpage`). For
+ * fetching schemas by name; the results are then filtered with {@link matchEasName}.
+ */
+export declare function easNameVariants(name: string): string[];
+//# sourceMappingURL=easNames.d.ts.map

package/dist/easNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"easNames.d.ts","sourceRoot":"","sources":["../src/easNames.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,MAAM,MAAM,KAAG,MAMrB,CAAA;AAElB,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,CAAA;AAE7D,2EAA2E;AAC3E,MAAM,MAAM,aAAa,GAAG,cAAc,CAAA;AAI1C,oEAAoE;AACpE,eAAO,MAAM,wBAAwB,EAAE,cAAwB,CAAA;AAE/D,oCAAoC;AACpC,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,KAAG,MAAsD,CAAA;AAEvG;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,EAAE,UAAS;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAO,KAAG,MAQjF,CAAA;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAO,GACnC,aAAa,GAAG,SAAS,CAK3B;AAED,eAAO,MAAM,kBAAkB,GAAI,MAAM,aAAa,EAAE,OAAO,cAAc,KAAG,OAC3C,CAAA;AAErC,eAAO,MAAM,qBAAqB,GAAI,GAAG,aAAa,EAAE,GAAG,aAAa,KAAG,MAC9C,CAAA;AAE7B,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,KAAK,EAAE,CAAC,CAAA;IACR,6FAA6F;IAC7F,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wEAAwE;IACxE,KAAK,CAAC,EAAE,cAAc,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,IACzB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GAChD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,CAAC,EAAE,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpB;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,SAAS,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAC3C,eAAe,CAAC,CAAC,CAAC,CAgBpB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC5B,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,cAAc,CAAA;CAAO,GAC3D,GAAG,CAAC,MAAM,CAAC,CAeb;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAGtD"}

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './domainOwnership.js';
 export * from './publishAuthorization.js';
 export * from './easPropertyCanonical.js';
 export * from './easRefAttester.js';
+export * from './easNames.js';
 export * from './easRevokedFilter.js';
 export * from './easUid.js';
 export * from './publishedBy.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,8BAA8B,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAC3D,cAAc,kCAAkC,CAAA;AAChD,YAAY,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAA;AAC/E,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACpF,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,GAC5B,MAAM,kBAAkB,CAAA;AACzB,cAAc,4BAA4B,CAAA;AAC1C,YAAY,EACV,WAAW,EACX,MAAM,IAAI,SAAS,EACnB,gBAAgB,GACjB,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qBAAqB,CAAA;AACnC,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,8BAA8B,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AACxD,YAAY,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAC3D,cAAc,kCAAkC,CAAA;AAChD,YAAY,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAA;AAC/E,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACpF,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,GAC5B,MAAM,kBAAkB,CAAA;AACzB,cAAc,4BAA4B,CAAA;AAC1C,YAAY,EACV,WAAW,EACX,MAAM,IAAI,SAAS,EACnB,gBAAgB,GACjB,MAAM,0BAA0B,CAAA"}