@mdbase-dev/connect-protocol 0.1.0-beta.116 → 0.1.0-beta.117

package/dist/collection-setup.d.ts

@@ -1,4 +1,11 @@
 import type { ContractSetupChoice, TypePackAssessment, TypePackProvision, TypePackReceipt } from "./type-packs.js";
+/**
+ * The one core configuration target: an application may add a record format
+ * its data is stored as. Every other target is inside an `x-*` namespace.
+ */
+export declare const RECORD_EXTENSIONS_CONFIGURATION_PATH: "/settings/record_extensions";
+/** The connector's engine reads `.base` files as YAML document records (mdbase spec Chapter 03). */
+export declare const YAML_DOCUMENT_RECORDS_CAPABILITY: "yaml-document-records-v1";
 export type ConfigurationContributionValue = string | number | boolean | null;
 export interface ConfigurationRequirement {
     id: string;

package/dist/collection-setup.js

@@ -1 +1,7 @@
-export {};
+/**
+ * The one core configuration target: an application may add a record format
+ * its data is stored as. Every other target is inside an `x-*` namespace.
+ */
+export const RECORD_EXTENSIONS_CONFIGURATION_PATH = "/settings/record_extensions";
+/** The connector's engine reads `.base` files as YAML document records (mdbase spec Chapter 03). */
+export const YAML_DOCUMENT_RECORDS_CAPABILITY = "yaml-document-records-v1";

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import type { ApplicationFileRequirement, LegacyApplicationFileRequirement, Coll
 import type { CollectionOperation } from "./operations.js";
 import type { ApplicationCapabilityRequirements, LegacyApplicationCapabilityRequirements } from "./capabilities.js";
 import type { ContractRequirement, ContractSetupChoice, TypePackProvision } from "./type-packs.js";
-import type { ConfigurationProvision, ConfigurationRequirement } from "./collection-setup.js";
+import { type ConfigurationProvision, type ConfigurationRequirement } from "./collection-setup.js";
 import type { ApplicationAuthorizationProof } from "./application-authorization.js";
 export * from "./connect-problems.generated.js";
 export * from "./files.js";
@@ -33,7 +33,7 @@ export declare const HOSTED_PROVIDER_REQUIRED_CAPABILITIES: readonly ["durable-m
 export declare const HOSTED_CANDIDATE_B_ACTIVATION_CAPABILITY: "candidate-b-activation-v1";
 export declare const HOSTED_PROVIDER_CAPABILITIES: readonly [...string[], "durable-mutation-journal-v1", "durable-file-lifecycle-v1", "contract-metadata-read-v1", "mutation-replay-after-credential-retirement-v1", "candidate-b-activation-v1"];
 export declare const APPLICATION_DECLARATION_EVIDENCE_CAPABILITY: "application-declaration-evidence-v1";
-export declare const RELAY_CAPABILITIES: readonly [...string[], "application-declaration-evidence-v1", "application-authorization-v4", "authorization-activation", "encrypted-relay", "policy-ack", "policy-freshness-lease-v1", "application-authorization-v5", "contract-setup-v1", "file-relay-v1", "protocol-usage-report-v1"];
+export declare const RELAY_CAPABILITIES: readonly [...string[], "application-declaration-evidence-v1", "application-authorization-v4", "authorization-activation", "encrypted-relay", "policy-ack", "policy-freshness-lease-v1", "application-authorization-v5", "contract-setup-v1", "file-relay-v1", "protocol-usage-report-v1", "yaml-document-records-v1"];
 export declare const AUTHORITY_PROOF_VERSION: 1;
 export declare const AUTHORITY_PROOF_ALGORITHM: "P256-SHA256";
 export declare const AUTHORITY_PROOF_DOMAIN: "mdbase-authority-request-proof-v1";

package/dist/index.js

@@ -1,4 +1,5 @@
 import { FRESH_APPLICATION_AUTHORIZATION_CAPABILITIES } from "./capabilities.js";
+import { YAML_DOCUMENT_RECORDS_CAPABILITY } from "./collection-setup.js";
 export * from "./connect-problems.generated.js";
 export * from "./files.js";
 export * from "./operations.js";
@@ -49,7 +50,8 @@ export const RELAY_CAPABILITIES = [
     "application-authorization-v5",
     CONTRACT_SETUP_CAPABILITY,
     FILE_RELAY_CAPABILITY,
-    PROTOCOL_USAGE_REPORT_CAPABILITY
+    PROTOCOL_USAGE_REPORT_CAPABILITY,
+    YAML_DOCUMENT_RECORDS_CAPABILITY
 ];
 export const AUTHORITY_PROOF_VERSION = 1;
 export const AUTHORITY_PROOF_ALGORITHM = "P256-SHA256";

package/dist/manifest.js

@@ -3,6 +3,7 @@ import { Ajv2020 } from "ajv/dist/2020.js";
 import addFormatsModule from "ajv-formats";
 import appManifestSchema from "../schemas/mdbase-app.schema.json" with { type: "json" };
 import legacyAppManifestSchema from "../schemas/mdbase-app.legacy-v1.schema.json" with { type: "json" };
+import { RECORD_EXTENSIONS_CONFIGURATION_PATH } from "./collection-setup.js";
 import { isNativeRedirectUri } from "./index.js";
 export const APPLICATION_MANIFEST_MAX_BYTES = 524_288;
 export class AppManifestValidationError extends Error {
@@ -322,7 +323,7 @@ function validateConfigurationSetup(value) {
         const requirement = asObject(candidate);
         const id = String(requirement.id);
         const path = String(requirement.path);
-        const pathError = configurationPointerError(path);
+        const pathError = configurationPointerError(path, requirement.value);
         if (pathError) {
             issues.push(issue(`/requirements/configuration/${index}/path`, "configurationPointer", pathError));
         }
@@ -339,7 +340,7 @@ function validateConfigurationSetup(value) {
         const provision = asObject(candidate);
         const requirementId = String(provision.requirement);
         const path = String(provision.path);
-        const pathError = configurationPointerError(path);
+        const pathError = configurationPointerError(path, provision.value);
         if (pathError) {
             issues.push(issue(`/provisions/configuration/${index}/path`, "configurationPointer", pathError));
         }
@@ -371,7 +372,14 @@ function validateConfigurationSetup(value) {
     }
     return issues;
 }
-function configurationPointerError(path) {
+// Matches mdbase-rs collection setup.
+const APPLICATION_RECORD_EXTENSIONS = ["md", "base"];
+function configurationPointerError(path, value) {
+    if (path === RECORD_EXTENSIONS_CONFIGURATION_PATH) {
+        return APPLICATION_RECORD_EXTENSIONS.includes(value)
+            ? undefined
+            : "accepts only the record extensions md and base";
+    }
     if (!path.startsWith("/") || new TextEncoder().encode(path).byteLength > 1024) {
         return "must be a bounded RFC 6901 JSON pointer";
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/connect-protocol",
-  "version": "0.1.0-beta.116",
+  "version": "0.1.0-beta.117",
   "private": false,
   "type": "module",
   "license": "MIT",

package/schemas/connect-protocol.v1.schema.json

@@ -447,7 +447,7 @@
       "required": ["id", "path", "predicate", "value"],
       "properties": {
         "id": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" },
-        "path": { "type": "string", "pattern": "^/x-[^/]+(?:/.*)?$", "maxLength": 1024 },
+        "path": { "type": "string", "pattern": "^(?:/settings/record_extensions|/x-[^/]+(?:/.*)?)$", "maxLength": 1024 },
         "predicate": { "const": "contains" },
         "value": { "oneOf": [
           { "type": "string" },
@@ -464,7 +464,7 @@
       "properties": {
         "requirement": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" },
         "operation": { "const": "set_add" },
-        "path": { "type": "string", "pattern": "^/x-[^/]+(?:/.*)?$", "maxLength": 1024 },
+        "path": { "type": "string", "pattern": "^(?:/settings/record_extensions|/x-[^/]+(?:/.*)?)$", "maxLength": 1024 },
         "value": { "oneOf": [
           { "type": "string" },
           { "type": "number" },