@kubun/scalars 0.12.0 → 0.13.0

package/lib/index.d.ts

@@ -1,7 +1,40 @@
 import type { JSONSchema } from 'json-schema-typed';
-export declare const attachmentIDSchema: JSONSchema.String;
-export declare const docIDSchema: JSONSchema.String;
-export declare const urlSchema: JSONSchema.String;
+/**
+ * The hand-written schemas below are `as const satisfies` rather than annotated.
+ *
+ * An annotation widens `type` back to `JSONSchema.String['type']`, which is
+ * optional — and `DocumentModel['schema']` is generated from a JSON schema, so
+ * its property union requires the literal `'string'`. Annotated, these constants
+ * type-check everywhere except the one place they are for: a model literal.
+ */
+export declare const attachmentIDSchema: {
+    readonly type: "string";
+    readonly title: "AttachmentID";
+    readonly pattern: "^k[0-9a-z]{10,120}$";
+};
+/**
+ * A reference to a credential entry, which is all a document ever holds of one:
+ * the plaintext is not in the graph and does not resolve through a field.
+ *
+ * The pattern is the shared `KubunID` one and separates nothing — a document id
+ * and a credential key id both match it. Only the decoded type varint tells them
+ * apart, which is `GraphQLCredentialEntryID`'s job at the boundary.
+ */
+export declare const credentialEntryIDSchema: {
+    readonly type: "string";
+    readonly title: "CredentialEntryID";
+    readonly pattern: "^k[0-9a-z]{10,120}$";
+};
+export declare const docIDSchema: {
+    readonly type: "string";
+    readonly title: "DocID";
+    readonly pattern: "^k[0-9a-z]{10,120}$";
+};
+export declare const urlSchema: {
+    readonly type: "string";
+    readonly format: "uri";
+    readonly title: "URL";
+};
 export declare const bigIntSchema: JSONSchema.Integer;
 export declare const didSchema: JSONSchema.String;
 export declare const dateTimeSchema: JSONSchema.String;

package/lib/index.js

@@ -5,11 +5,30 @@ function createScalarSchema(type) {
         title: type.name
     };
 }
-export const attachmentIDSchema = {
+/**
+ * The hand-written schemas below are `as const satisfies` rather than annotated.
+ *
+ * An annotation widens `type` back to `JSONSchema.String['type']`, which is
+ * optional — and `DocumentModel['schema']` is generated from a JSON schema, so
+ * its property union requires the literal `'string'`. Annotated, these constants
+ * type-check everywhere except the one place they are for: a model literal.
+ */ export const attachmentIDSchema = {
     type: 'string',
     title: 'AttachmentID',
     pattern: '^k[0-9a-z]{10,120}$'
 };
+/**
+ * A reference to a credential entry, which is all a document ever holds of one:
+ * the plaintext is not in the graph and does not resolve through a field.
+ *
+ * The pattern is the shared `KubunID` one and separates nothing — a document id
+ * and a credential key id both match it. Only the decoded type varint tells them
+ * apart, which is `GraphQLCredentialEntryID`'s job at the boundary.
+ */ export const credentialEntryIDSchema = {
+    type: 'string',
+    title: 'CredentialEntryID',
+    pattern: '^k[0-9a-z]{10,120}$'
+};
 export const docIDSchema = {
     type: 'string',
     title: 'DocID',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/scalars",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -15,11 +15,14 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "graphql-scalars": "^1.25.0"
+    "graphql-scalars": "^2.0.0"
   },
   "devDependencies": {
     "json-schema-typed": "^8.0.2"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
     "build:clean": "del lib",