@enbox/dwn-sdk-js 0.4.0 → 0.4.2

package/dist/esm/src/utils/protocol-tags.js

@@ -0,0 +1,262 @@
+const allowedTagTypes = new Set(['string', 'number', 'integer', 'boolean', 'array']);
+const allowedArrayItemTypes = new Set(['string', 'number', 'integer']);
+const numericConstraintKeywords = ['minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum'];
+const stringConstraintKeywords = ['minLength', 'maxLength'];
+const arrayConstraintKeywords = ['minItems', 'maxItems', 'minContains', 'maxContains'];
+function isRecord(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+function pathSegment(segment) {
+    return String(segment).replaceAll('~', '~0').replaceAll('/', '~1');
+}
+function appendPath(path, segment) {
+    return `${path}/${pathSegment(segment)}`;
+}
+function hasOwnProperty(value, property) {
+    return Object.hasOwn(value, property);
+}
+function addError(errors, instancePath, message) {
+    errors.push({ instancePath, message });
+}
+function isNumber(value) {
+    return typeof value === 'number' && Number.isFinite(value);
+}
+function valuesEqual(left, right) {
+    if (Object.is(left, right)) {
+        return true;
+    }
+    if (Array.isArray(left) && Array.isArray(right)) {
+        return left.length === right.length && left.every((value, index) => valuesEqual(value, right[index]));
+    }
+    if (isRecord(left) && isRecord(right)) {
+        const leftKeys = Object.keys(left);
+        const rightKeys = Object.keys(right);
+        return leftKeys.length === rightKeys.length
+            && leftKeys.every(key => Object.hasOwn(right, key) && valuesEqual(left[key], right[key]));
+    }
+    return false;
+}
+function getTagSchemas(tagsDefinition) {
+    const schemas = {};
+    for (const [tag, schema] of Object.entries(tagsDefinition)) {
+        if (tag === '$requiredTags' || tag === '$allowUndefinedTags') {
+            continue;
+        }
+        schemas[tag] = schema;
+    }
+    return schemas;
+}
+function validateSchemaConstraintTypes(schema, dataPath, errors) {
+    if (schema.enum !== undefined) {
+        if (!Array.isArray(schema.enum) || schema.enum.length === 0) {
+            addError(errors, appendPath(dataPath, 'enum'), 'must be non-empty array');
+        }
+    }
+    for (const keyword of numericConstraintKeywords) {
+        if (schema[keyword] !== undefined && !isNumber(schema[keyword])) {
+            addError(errors, appendPath(dataPath, keyword), 'must be number');
+        }
+    }
+    for (const keyword of [...stringConstraintKeywords, ...arrayConstraintKeywords]) {
+        if (schema[keyword] !== undefined && (!Number.isInteger(schema[keyword]) || schema[keyword] < 0)) {
+            addError(errors, appendPath(dataPath, keyword), 'must be integer');
+        }
+    }
+    if (schema.uniqueItems !== undefined && typeof schema.uniqueItems !== 'boolean') {
+        addError(errors, appendPath(dataPath, 'uniqueItems'), 'must be boolean');
+    }
+}
+function validateTagSubschemaDefinition(schema, dataPath, allowedTypes, errors) {
+    if (!isRecord(schema)) {
+        addError(errors, dataPath, 'must be object');
+        return;
+    }
+    if (schema.type !== undefined && (typeof schema.type !== 'string' || !allowedTypes.has(schema.type))) {
+        addError(errors, appendPath(dataPath, 'type'), 'must be equal to one of the allowed values');
+    }
+    validateSchemaConstraintTypes(schema, dataPath, errors);
+}
+/**
+ * Validates DWN protocol tag schema definitions without invoking Ajv's runtime compiler.
+ *
+ * The broader protocol message shape is already checked by the precompiled
+ * ProtocolRuleSet validator. This function covers the tag-schema constraints
+ * that are deliberately modeled as a small DWN subset rather than arbitrary
+ * JSON Schema.
+ */
+export function validateProtocolTagSchemaDefinition(schema, dataVar) {
+    const errors = [];
+    validateTagSubschemaDefinition(schema, '', allowedTagTypes, errors);
+    if (isRecord(schema)) {
+        if (schema.items !== undefined) {
+            validateTagSubschemaDefinition(schema.items, '/items', allowedArrayItemTypes, errors);
+        }
+        if (schema.contains !== undefined) {
+            validateTagSubschemaDefinition(schema.contains, '/contains', allowedArrayItemTypes, errors);
+        }
+    }
+    return formatTagValidationErrors(errors, dataVar);
+}
+function validateType(type, value, dataPath, errors) {
+    switch (type) {
+        case undefined:
+            return true;
+        case 'string':
+            if (typeof value === 'string') {
+                return true;
+            }
+            addError(errors, dataPath, 'must be string');
+            return false;
+        case 'number':
+            if (isNumber(value)) {
+                return true;
+            }
+            addError(errors, dataPath, 'must be number');
+            return false;
+        case 'integer':
+            if (isNumber(value) && Number.isInteger(value)) {
+                return true;
+            }
+            addError(errors, dataPath, 'must be integer');
+            return false;
+        case 'boolean':
+            if (typeof value === 'boolean') {
+                return true;
+            }
+            addError(errors, dataPath, 'must be boolean');
+            return false;
+        case 'array':
+            if (Array.isArray(value)) {
+                return true;
+            }
+            addError(errors, dataPath, 'must be array');
+            return false;
+        default:
+            addError(errors, dataPath, 'must match a supported tag schema type');
+            return false;
+    }
+}
+function validateEnum(schema, value, dataPath, errors) {
+    if (Array.isArray(schema.enum) && !schema.enum.some(allowed => valuesEqual(allowed, value))) {
+        addError(errors, dataPath, 'must be equal to one of the allowed values');
+    }
+}
+function validateNumberConstraints(schema, value, dataPath, errors) {
+    if (!isNumber(value)) {
+        return;
+    }
+    if (isNumber(schema.minimum) && value < schema.minimum) {
+        addError(errors, dataPath, `must be >= ${schema.minimum}`);
+    }
+    if (isNumber(schema.maximum) && value > schema.maximum) {
+        addError(errors, dataPath, `must be <= ${schema.maximum}`);
+    }
+    if (isNumber(schema.exclusiveMinimum) && value <= schema.exclusiveMinimum) {
+        addError(errors, dataPath, `must be > ${schema.exclusiveMinimum}`);
+    }
+    if (isNumber(schema.exclusiveMaximum) && value >= schema.exclusiveMaximum) {
+        addError(errors, dataPath, `must be < ${schema.exclusiveMaximum}`);
+    }
+}
+function validateStringConstraints(schema, value, dataPath, errors) {
+    if (typeof value !== 'string') {
+        return;
+    }
+    if (Number.isInteger(schema.minLength) && value.length < schema.minLength) {
+        addError(errors, dataPath, `must NOT have fewer than ${schema.minLength} characters`);
+    }
+    if (Number.isInteger(schema.maxLength) && value.length > schema.maxLength) {
+        addError(errors, dataPath, `must NOT have more than ${schema.maxLength} characters`);
+    }
+}
+function validateArrayConstraints(schema, value, dataPath, errors) {
+    if (!Array.isArray(value)) {
+        return;
+    }
+    if (Number.isInteger(schema.minItems) && value.length < schema.minItems) {
+        addError(errors, dataPath, `must NOT have fewer than ${schema.minItems} items`);
+    }
+    if (Number.isInteger(schema.maxItems) && value.length > schema.maxItems) {
+        addError(errors, dataPath, `must NOT have more than ${schema.maxItems} items`);
+    }
+    if (schema.uniqueItems === true) {
+        for (let i = 0; i < value.length; i++) {
+            for (let j = i + 1; j < value.length; j++) {
+                if (valuesEqual(value[i], value[j])) {
+                    addError(errors, dataPath, 'must NOT have duplicate items');
+                    return;
+                }
+            }
+        }
+    }
+}
+function validateTagValue(schema, value, dataPath, errors) {
+    if (!isRecord(schema)) {
+        addError(errors, dataPath, 'must match a supported tag schema');
+        return;
+    }
+    const validType = validateType(schema.type, value, dataPath, errors);
+    if (!validType) {
+        return;
+    }
+    validateEnum(schema, value, dataPath, errors);
+    validateNumberConstraints(schema, value, dataPath, errors);
+    validateStringConstraints(schema, value, dataPath, errors);
+    validateArrayConstraints(schema, value, dataPath, errors);
+    if (Array.isArray(value) && isRecord(schema.items)) {
+        value.forEach((item, index) => validateTagValue(schema.items, item, appendPath(dataPath, index), errors));
+    }
+    if (Array.isArray(value) && isRecord(schema.contains)) {
+        validateContains(schema, value, dataPath, errors);
+    }
+}
+function validateContains(schema, value, dataPath, errors) {
+    const minimumCount = Number.isInteger(schema.minContains) ? schema.minContains : 1;
+    const maximumCount = Number.isInteger(schema.maxContains) ? schema.maxContains : undefined;
+    const validItemCount = value.filter(item => {
+        const itemErrors = [];
+        validateTagValue(schema.contains, item, dataPath, itemErrors);
+        return itemErrors.length === 0;
+    }).length;
+    if (validItemCount < minimumCount || (maximumCount !== undefined && validItemCount > maximumCount)) {
+        const message = maximumCount === undefined
+            ? `must contain at least ${minimumCount} valid item(s)`
+            : `must contain at least ${minimumCount} and no more than ${maximumCount} valid item(s)`;
+        addError(errors, dataPath, message);
+    }
+}
+/**
+ * Validates a record's `descriptor.tags` against a protocol rule set `$tags` definition.
+ */
+export function validateProtocolTags(tagsDefinition, tags, dataVar) {
+    const errors = [];
+    const tagSchemas = getTagSchemas(tagsDefinition);
+    const requiredTags = Array.isArray(tagsDefinition.$requiredTags) ? tagsDefinition.$requiredTags : [];
+    for (const requiredTag of requiredTags) {
+        if (!hasOwnProperty(tags, requiredTag)) {
+            addError(errors, '', `must have required property '${requiredTag}'`);
+        }
+    }
+    if (tagsDefinition.$allowUndefinedTags !== true) {
+        for (const tag of Object.keys(tags)) {
+            if (tagSchemas[tag] === undefined) {
+                addError(errors, '', 'must NOT have additional properties');
+            }
+        }
+    }
+    for (const [tag, schema] of Object.entries(tagSchemas)) {
+        if (hasOwnProperty(tags, tag)) {
+            validateTagValue(schema, tags[tag], appendPath('', tag), errors);
+        }
+    }
+    return formatTagValidationErrors(errors, dataVar);
+}
+function formatTagValidationErrors(errors, dataVar) {
+    if (errors.length === 0) {
+        return undefined;
+    }
+    return errors
+        .map(error => `${dataVar}${error.instancePath} ${error.message}`)
+        .join(', ');
+}
+//# sourceMappingURL=protocol-tags.js.map

package/dist/esm/src/utils/protocol-tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-tags.js","sourceRoot":"","sources":["../../../../src/utils/protocol-tags.ts"],"names":[],"mappings":"AASA,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACrF,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AACvE,MAAM,yBAAyB,GAAG,CAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,kBAAkB,CAAE,CAAC;AACnG,MAAM,wBAAwB,GAAG,CAAE,WAAW,EAAE,WAAW,CAAE,CAAC;AAC9D,MAAM,uBAAuB,GAAG,CAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,CAAE,CAAC;AAEzF,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,WAAW,CAAC,OAAwB;IAC3C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,OAAwB;IACxD,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;AAC3C,CAAC;AAED,SAAS,cAAc,CAAC,KAA8B,EAAE,QAAgB;IACtE,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,QAAQ,CAAC,MAA4B,EAAE,YAAoB,EAAE,OAAe;IACnF,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,WAAW,CAAC,IAAa,EAAE,KAAc;IAChD,IAAI,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxG,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAErC,OAAO,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;eACtC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,cAAsC;IAC3D,MAAM,OAAO,GAA8B,EAAE,CAAC;IAE9C,KAAK,MAAM,CAAE,GAAG,EAAE,MAAM,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QAC7D,IAAI,GAAG,KAAK,eAAe,IAAI,GAAG,KAAK,qBAAqB,EAAE,CAAC;YAC7D,SAAS;QACX,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,GAAG,MAAmB,CAAC;IACrC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,6BAA6B,CACpC,MAA+B,EAC/B,QAAgB,EAChB,MAA4B;IAE5B,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5D,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,yBAAyB,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,yBAAyB,EAAE,CAAC;QAChD,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAChE,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,CAAE,GAAG,wBAAwB,EAAE,GAAG,uBAAuB,CAAE,EAAE,CAAC;QAClF,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAK,MAAM,CAAC,OAAO,CAAY,GAAG,CAAC,CAAC,EAAE,CAAC;YAC7G,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,iBAAiB,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAChF,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,SAAS,8BAA8B,CACrC,MAAe,EACf,QAAgB,EAChB,YAAyB,EACzB,MAA4B;IAE5B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAC7C,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACrG,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,4CAA4C,CAAC,CAAC;IAC/F,CAAC;IAED,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CACjD,MAAe,EACf,OAAe;IAEf,MAAM,MAAM,GAAyB,EAAE,CAAC;IAExC,8BAA8B,CAAC,MAAM,EAAE,EAAE,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;IAEpE,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,8BAA8B,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,8BAA8B,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,CAAC,CAAC;QAC9F,CAAC;IACH,CAAC;IAED,OAAO,yBAAyB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,YAAY,CAAC,IAAa,EAAE,KAAc,EAAE,QAAgB,EAAE,MAA4B;IACjG,QAAQ,IAAI,EAAE,CAAC;QACf,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC;QACd,KAAK,QAAQ;YACX,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,KAAK,QAAQ;YACX,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,KAAK,SAAS;YACZ,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/C,OAAO,IAAI,CAAC;YACd,CAAC;YACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAC9C,OAAO,KAAK,CAAC;QACf,KAAK,SAAS;YACZ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAC9C,OAAO,KAAK,CAAC;QACf,KAAK,OAAO;YACV,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;YAC5C,OAAO,KAAK,CAAC;QACf;YACE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,wCAAwC,CAAC,CAAC;YACrE,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAA+B,EAAE,KAAc,EAAE,QAAgB,EAAE,MAA4B;IACnH,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;QAC5F,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,4CAA4C,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAChC,MAA+B,EAC/B,KAAc,EACd,QAAgB,EAChB,MAA4B;IAE5B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QACvD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QACvD,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC1E,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC1E,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAChC,MAA+B,EAC/B,KAAc,EACd,QAAgB,EAChB,MAA4B;IAE5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,MAAM,GAAI,MAAM,CAAC,SAAoB,EAAE,CAAC;QACtF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,4BAA4B,MAAM,CAAC,SAAS,aAAa,CAAC,CAAC;IACxF,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,MAAM,GAAI,MAAM,CAAC,SAAoB,EAAE,CAAC;QACtF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,2BAA2B,MAAM,CAAC,SAAS,aAAa,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAC/B,MAA+B,EAC/B,KAAc,EACd,QAAgB,EAChB,MAA4B;IAE5B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,MAAM,GAAI,MAAM,CAAC,QAAmB,EAAE,CAAC;QACpF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,4BAA4B,MAAM,CAAC,QAAQ,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,MAAM,GAAI,MAAM,CAAC,QAAmB,EAAE,CAAC;QACpF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,2BAA2B,MAAM,CAAC,QAAQ,QAAQ,CAAC,CAAC;IACjF,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACpC,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,+BAA+B,CAAC,CAAC;oBAC5D,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAe,EACf,KAAc,EACd,QAAgB,EAChB,MAA4B;IAE5B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,mCAAmC,CAAC,CAAC;QAChE,OAAO;IACT,CAAC;IAED,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC9C,yBAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC3D,yBAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC3D,wBAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE1D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtD,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,MAA+B,EAC/B,KAAgB,EAChB,QAAgB,EAChB,MAA4B;IAE5B,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7F,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;IACrG,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACzC,MAAM,UAAU,GAAyB,EAAE,CAAC;QAC5C,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC9D,OAAO,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC,MAAM,CAAC;IAEV,IAAI,cAAc,GAAG,YAAY,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,cAAc,GAAG,YAAY,CAAC,EAAE,CAAC;QACnG,MAAM,OAAO,GAAG,YAAY,KAAK,SAAS;YACxC,CAAC,CAAC,yBAAyB,YAAY,gBAAgB;YACvD,CAAC,CAAC,yBAAyB,YAAY,qBAAqB,YAAY,gBAAgB,CAAC;QAC3F,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,cAAsC,EACtC,IAA6B,EAC7B,OAAe;IAEf,MAAM,MAAM,GAAyB,EAAE,CAAC;IACxC,MAAM,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;IACjD,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAErG,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;YACvC,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,gCAAgC,WAAW,GAAG,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAED,IAAI,cAAc,CAAC,mBAAmB,KAAK,IAAI,EAAE,CAAC;QAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;gBAClC,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,qCAAqC,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAE,GAAG,EAAE,MAAM,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACzD,IAAI,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YAC9B,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,OAAO,yBAAyB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,yBAAyB,CAAC,MAA4B,EAAE,OAAe;IAC9E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,MAAM;SACV,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;SAChE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/esm/src/utils/record-limit-occupancy.js

@@ -0,0 +1,244 @@
+import { FilterUtility } from './filter.js';
+import { getRuleSetAtPath } from './protocols.js';
+import { lexicographicalCompare } from './string.js';
+import { ProtocolRecordLimitStrategy } from '../types/protocols-types.js';
+import { Records } from './records.js';
+import { SortDirection } from '../types/query-types.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+/**
+ * Queries records with bounded `$recordLimit` occupancy projection when every limited filter targets one concrete scope.
+ *
+ * Broad filters keep the store's native query path. Projecting those without a store-level grouping primitive would require
+ * scanning the full matching set, which is worse than leaving them unprojected until a bounded broad-query strategy exists.
+ */
+export async function queryRecordsWithRecordLimitOccupancy(input) {
+    const filterResolution = await resolveRecordLimitFilters(input);
+    if (filterResolution === undefined) {
+        const { messages, cursor } = await input.messageStore.query(input.tenant, input.filters, input.messageSort, input.pagination);
+        return { messages: messages.filter(Records.isRecordsWrite), cursor };
+    }
+    if (filterResolution.projectedFilters.length === 0) {
+        return { messages: [] };
+    }
+    const { messages, cursor } = await input.messageStore.query(input.tenant, filterResolution.projectedFilters, input.messageSort, input.pagination);
+    return { messages: messages.filter(Records.isRecordsWrite), cursor };
+}
+/**
+ * Counts records with bounded `$recordLimit` occupancy projection when every limited filter targets one concrete scope.
+ */
+export async function countRecordsWithRecordLimitOccupancy(input) {
+    const filterResolution = await resolveRecordLimitFilters(input);
+    if (filterResolution === undefined) {
+        return input.messageStore.count(input.tenant, input.filters, input.messageSort);
+    }
+    if (filterResolution.projectedFilters.length === 0) {
+        return 0;
+    }
+    return input.messageStore.count(input.tenant, filterResolution.projectedFilters, input.messageSort);
+}
+/**
+ * Returns true when the latest RecordsWrite is visible under the `$recordLimit` projection.
+ */
+export async function isRecordLimitOccupant(input) {
+    const recordLimit = await getRecordLimitForMessage({
+        messageStore: input.messageStore,
+        validationStateReader: input.validationStateReader,
+        tenant: input.tenant,
+        message: input.message,
+        messageTimestamp: input.messageTimestamp,
+        recordLimitDefinitions: new Map(),
+    });
+    if (recordLimit === undefined) {
+        return true;
+    }
+    const occupantRecordIds = await findOccupantRecordIds({
+        messageStore: input.messageStore,
+        tenant: input.tenant,
+        scope: getRecordLimitScope(input.message),
+        recordLimit,
+    });
+    return occupantRecordIds.has(input.message.recordId);
+}
+async function resolveRecordLimitFilters(input) {
+    const recordLimitDefinitions = new Map();
+    const projectedFilters = [];
+    let projectionApplied = false;
+    for (const filter of input.filters) {
+        const recordLimit = await getRecordLimitForFilter({
+            messageStore: input.messageStore,
+            validationStateReader: input.validationStateReader,
+            tenant: input.tenant,
+            filter,
+            messageTimestamp: input.messageTimestamp,
+            recordLimitDefinitions,
+        });
+        if (recordLimit === undefined) {
+            projectedFilters.push(filter);
+            continue;
+        }
+        const scope = getRecordLimitScopeFromFilter(filter);
+        if (scope === undefined) {
+            return undefined;
+        }
+        const occupantRecordIds = await findOccupantRecordIds({
+            messageStore: input.messageStore,
+            tenant: input.tenant,
+            scope,
+            recordLimit,
+        });
+        const projectedFilter = buildProjectedFilter(filter, occupantRecordIds);
+        if (projectedFilter !== undefined) {
+            projectedFilters.push(projectedFilter);
+        }
+        projectionApplied = true;
+    }
+    return projectionApplied ? { projectedFilters } : undefined;
+}
+async function getRecordLimitForMessage(input) {
+    const { protocol, protocolPath } = input.message.descriptor;
+    if (protocol === undefined || protocolPath === undefined) {
+        return undefined;
+    }
+    return getRecordLimit({
+        validationStateReader: input.validationStateReader,
+        tenant: input.tenant,
+        protocol,
+        protocolPath,
+        messageTimestamp: input.messageTimestamp,
+        recordLimitDefinitions: input.recordLimitDefinitions,
+    });
+}
+async function getRecordLimitForFilter(input) {
+    if (input.filter.interface !== DwnInterfaceName.Records ||
+        input.filter.method !== DwnMethodName.Write ||
+        input.filter.isLatestBaseState !== true) {
+        return undefined;
+    }
+    const { protocol, protocolPath } = input.filter;
+    if (typeof protocol !== 'string' || typeof protocolPath !== 'string') {
+        return undefined;
+    }
+    return getRecordLimit({
+        validationStateReader: input.validationStateReader,
+        tenant: input.tenant,
+        protocol,
+        protocolPath,
+        messageTimestamp: input.messageTimestamp,
+        recordLimitDefinitions: input.recordLimitDefinitions,
+    });
+}
+async function getRecordLimit(input) {
+    const key = `${input.protocol}\u0000${input.protocolPath}`;
+    if (!input.recordLimitDefinitions.has(key)) {
+        let protocolDefinition;
+        try {
+            protocolDefinition = await input.validationStateReader.fetchProtocolDefinition(input.tenant, input.protocol, input.messageTimestamp);
+        }
+        catch (error) {
+            if (error instanceof DwnError && error.code === DwnErrorCode.ProtocolAuthorizationProtocolNotFound) {
+                input.recordLimitDefinitions.set(key, undefined);
+                return undefined;
+            }
+            throw error;
+        }
+        const ruleSet = getRuleSetAtPath(input.protocolPath, protocolDefinition.structure);
+        const recordLimit = ruleSet?.$recordLimit;
+        input.recordLimitDefinitions.set(key, recordLimit?.strategy === ProtocolRecordLimitStrategy.Reject ? recordLimit : undefined);
+    }
+    return input.recordLimitDefinitions.get(key);
+}
+async function findOccupantRecordIds(input) {
+    const scopeFilter = buildRecordLimitScopeFilter(input.scope);
+    const messageSort = { dateCreated: SortDirection.Ascending };
+    const { messages: firstPage } = await input.messageStore.query(input.tenant, [scopeFilter], messageSort, { limit: input.recordLimit.max });
+    const firstPageCandidates = firstPage.filter(Records.isRecordsWrite);
+    if (firstPageCandidates.length === 0) {
+        return new Set();
+    }
+    const boundaryDateCreated = firstPageCandidates.at(-1).descriptor.dateCreated;
+    const beforeBoundary = firstPageCandidates.filter((message) => message.descriptor.dateCreated < boundaryDateCreated);
+    let boundaryCandidates = firstPageCandidates.filter((message) => message.descriptor.dateCreated === boundaryDateCreated);
+    if (firstPageCandidates.length === input.recordLimit.max) {
+        const { messages } = await input.messageStore.query(input.tenant, [{ ...scopeFilter, dateCreated: boundaryDateCreated }], messageSort);
+        boundaryCandidates = messages.filter(Records.isRecordsWrite);
+    }
+    boundaryCandidates.sort(compareRecordLimitCandidates);
+    const rankedCandidates = [
+        ...beforeBoundary,
+        ...boundaryCandidates,
+    ];
+    return new Set(rankedCandidates
+        .slice(0, input.recordLimit.max)
+        .map((message) => message.recordId));
+}
+function buildRecordLimitScopeFilter(scope) {
+    const filter = {
+        interface: DwnInterfaceName.Records,
+        method: DwnMethodName.Write,
+        isLatestBaseState: true,
+        protocol: scope.protocol,
+        protocolPath: scope.protocolPath,
+    };
+    if (scope.parentContextId !== '') {
+        filter.contextId = FilterUtility.constructPrefixFilterAsRangeFilter(scope.parentContextId);
+    }
+    return filter;
+}
+function getRecordLimitScopeFromFilter(filter) {
+    const { protocol, protocolPath } = filter;
+    if (typeof protocol !== 'string' || typeof protocolPath !== 'string') {
+        return undefined;
+    }
+    if (!protocolPath.includes('/')) {
+        return { protocol, protocolPath, parentContextId: '' };
+    }
+    const parentContextId = getExactParentContextIdFromFilter(filter);
+    if (parentContextId === undefined) {
+        return undefined;
+    }
+    return { protocol, protocolPath, parentContextId };
+}
+function getRecordLimitScope(message) {
+    return {
+        protocol: message.descriptor.protocol,
+        protocolPath: message.descriptor.protocolPath,
+        parentContextId: Records.getParentContextFromOfContextId(message.contextId) ?? '',
+    };
+}
+function getExactParentContextIdFromFilter(filter) {
+    const { contextId } = filter;
+    if (contextId === undefined || !FilterUtility.isRangeFilter(contextId)) {
+        return undefined;
+    }
+    if (typeof contextId.gte !== 'string' || contextId.lt !== `${contextId.gte}\uffff`) {
+        return undefined;
+    }
+    return contextId.gte;
+}
+function buildProjectedFilter(filter, occupantRecordIds) {
+    let projectedRecordIds = Array.from(occupantRecordIds);
+    const existingRecordIdFilter = filter.recordId;
+    if (typeof existingRecordIdFilter === 'string') {
+        projectedRecordIds = occupantRecordIds.has(existingRecordIdFilter) ? [existingRecordIdFilter] : [];
+    }
+    else if (Array.isArray(existingRecordIdFilter)) {
+        projectedRecordIds = existingRecordIdFilter
+            .filter((recordId) => typeof recordId === 'string' && occupantRecordIds.has(recordId));
+    }
+    if (projectedRecordIds.length === 0) {
+        return undefined;
+    }
+    return {
+        ...filter,
+        recordId: projectedRecordIds,
+    };
+}
+function compareRecordLimitCandidates(left, right) {
+    const dateComparison = lexicographicalCompare(left.descriptor.dateCreated, right.descriptor.dateCreated);
+    if (dateComparison !== 0) {
+        return dateComparison;
+    }
+    return lexicographicalCompare(left.recordId, right.recordId);
+}
+//# sourceMappingURL=record-limit-occupancy.js.map

package/dist/esm/src/utils/record-limit-occupancy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-limit-occupancy.js","sourceRoot":"","sources":["../../../../src/utils/record-limit-occupancy.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAyBnF;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CACxD,KAAqC;IAErC,MAAM,gBAAgB,GAAG,MAAM,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAChE,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9H,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IACvE,CAAC;IAED,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAC1B,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,CACzD,KAAK,CAAC,MAAM,EACZ,gBAAgB,CAAC,gBAAgB,EACjC,KAAK,CAAC,WAAW,EACjB,KAAK,CAAC,UAAU,CACjB,CAAC;IAEF,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;AACvE,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CAAC,KAAyD;IAClH,MAAM,gBAAgB,GAAG,MAAM,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAChE,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAClF,CAAC;IAED,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;AACtG,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,KAI3C;IACC,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC;QACjD,YAAY,EAAa,KAAK,CAAC,YAAY;QAC3C,qBAAqB,EAAI,KAAK,CAAC,qBAAqB;QACpD,MAAM,EAAmB,KAAK,CAAC,MAAM;QACrC,OAAO,EAAkB,KAAK,CAAC,OAAO;QACtC,gBAAgB,EAAS,KAAK,CAAC,gBAAgB;QAC/C,sBAAsB,EAAG,IAAI,GAAG,EAAE;KACnC,CAAC,CAAC;IAEH,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,iBAAiB,GAAG,MAAM,qBAAqB,CAAC;QACpD,YAAY,EAAG,KAAK,CAAC,YAAY;QACjC,MAAM,EAAS,KAAK,CAAC,MAAM;QAC3B,KAAK,EAAU,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC;QACjD,WAAW;KACZ,CAAC,CAAC;IAEH,OAAO,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED,KAAK,UAAU,yBAAyB,CACtC,KAAyD;IAEzD,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAqD,CAAC;IAC5F,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAE9B,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QACnC,MAAM,WAAW,GAAG,MAAM,uBAAuB,CAAC;YAChD,YAAY,EAAY,KAAK,CAAC,YAAY;YAC1C,qBAAqB,EAAG,KAAK,CAAC,qBAAqB;YACnD,MAAM,EAAkB,KAAK,CAAC,MAAM;YACpC,MAAM;YACN,gBAAgB,EAAQ,KAAK,CAAC,gBAAgB;YAC9C,sBAAsB;SACvB,CAAC,CAAC;QAEH,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,6BAA6B,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,qBAAqB,CAAC;YACpD,YAAY,EAAG,KAAK,CAAC,YAAY;YACjC,MAAM,EAAS,KAAK,CAAC,MAAM;YAC3B,KAAK;YACL,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QACxE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAClC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACzC,CAAC;QACD,iBAAiB,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED,OAAO,iBAAiB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9D,CAAC;AAED,KAAK,UAAU,wBAAwB,CAAC,KAKvC;IACC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;IAC5D,IAAI,QAAQ,KAAK,SAAS,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC;QACpB,qBAAqB,EAAI,KAAK,CAAC,qBAAqB;QACpD,MAAM,EAAmB,KAAK,CAAC,MAAM;QACrC,QAAQ;QACR,YAAY;QACZ,gBAAgB,EAAS,KAAK,CAAC,gBAAgB;QAC/C,sBAAsB,EAAG,KAAK,CAAC,sBAAsB;KACtD,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,uBAAuB,CAAC,KAKtC;IACC,IAAI,KAAK,CAAC,MAAM,CAAC,SAAS,KAAK,gBAAgB,CAAC,OAAO;QACrD,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,aAAa,CAAC,KAAK;QAC3C,KAAK,CAAC,MAAM,CAAC,iBAAiB,KAAK,IAAI,EACvC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;IAChD,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC;QACpB,qBAAqB,EAAI,KAAK,CAAC,qBAAqB;QACpD,MAAM,EAAmB,KAAK,CAAC,MAAM;QACrC,QAAQ;QACR,YAAY;QACZ,gBAAgB,EAAS,KAAK,CAAC,gBAAgB;QAC/C,sBAAsB,EAAG,KAAK,CAAC,sBAAsB;KACtD,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,KAO7B;IACC,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,QAAQ,SAAS,KAAK,CAAC,YAAY,EAAE,CAAC;IAC3D,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,kBAAkB,CAAC;QACvB,IAAI,CAAC;YACH,kBAAkB,GAAG,MAAM,KAAK,CAAC,qBAAqB,CAAC,uBAAuB,CAC5E,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,gBAAgB,CACvB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,qCAAqC,EAAE,CAAC;gBACnG,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;gBACjD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,YAAY,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACnF,MAAM,WAAW,GAAG,OAAO,EAAE,YAAY,CAAC;QAC1C,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAC9B,GAAG,EACH,WAAW,EAAE,QAAQ,KAAK,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CACvF,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC/C,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,KAKpC;IACC,MAAM,WAAW,GAAG,2BAA2B,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7D,MAAM,WAAW,GAAG,EAAE,WAAW,EAAE,aAAa,CAAC,SAAS,EAAE,CAAC;IAC7D,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,CAC5D,KAAK,CAAC,MAAM,EACZ,CAAC,WAAW,CAAC,EACb,WAAW,EACX,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CACjC,CAAC;IACF,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACrE,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,IAAI,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,UAAU,CAAC,WAAW,CAAC;IAC/E,MAAM,cAAc,GAAG,mBAAmB,CAAC,MAAM,CAC/C,CAAC,OAAO,EAAW,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,GAAG,mBAAmB,CAC3E,CAAC;IACF,IAAI,kBAAkB,GAAG,mBAAmB,CAAC,MAAM,CACjD,CAAC,OAAO,EAAW,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,KAAK,mBAAmB,CAC7E,CAAC;IAEF,IAAI,mBAAmB,CAAC,MAAM,KAAK,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QACzD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,CACjD,KAAK,CAAC,MAAM,EACZ,CAAC,EAAE,GAAG,WAAW,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,EACtD,WAAW,CACZ,CAAC;QACF,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED,kBAAkB,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAEtD,MAAM,gBAAgB,GAAG;QACvB,GAAG,cAAc;QACjB,GAAG,kBAAkB;KACtB,CAAC;IAEF,OAAO,IAAI,GAAG,CACZ,gBAAgB;SACb,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC;SAC/B,GAAG,CAAC,CAAC,OAAO,EAAU,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC9C,CAAC;AACJ,CAAC;AAED,SAAS,2BAA2B,CAAC,KAAuB;IAC1D,MAAM,MAAM,GAAW;QACrB,SAAS,EAAW,gBAAgB,CAAC,OAAO;QAC5C,MAAM,EAAc,aAAa,CAAC,KAAK;QACvC,iBAAiB,EAAG,IAAI;QACxB,QAAQ,EAAY,KAAK,CAAC,QAAQ;QAClC,YAAY,EAAQ,KAAK,CAAC,YAAY;KACvC,CAAC;IAEF,IAAI,KAAK,CAAC,eAAe,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,CAAC,SAAS,GAAG,aAAa,CAAC,kCAAkC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAC7F,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,6BAA6B,CAAC,MAAc;IACnD,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IAC1C,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;IACzD,CAAC;IAED,MAAM,eAAe,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAClE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACrD,CAAC;AAED,SAAS,mBAAmB,CAAC,OAA4B;IACvD,OAAO;QACL,QAAQ,EAAU,OAAO,CAAC,UAAU,CAAC,QAAQ;QAC7C,YAAY,EAAM,OAAO,CAAC,UAAU,CAAC,YAAY;QACjD,eAAe,EAAG,OAAO,CAAC,+BAA+B,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE;KACnF,CAAC;AACJ,CAAC;AAED,SAAS,iCAAiC,CAAC,MAAc;IACvD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAC7B,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QACvE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,GAAG,KAAK,QAAQ,IAAI,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC,GAAG,QAAQ,EAAE,CAAC;QACnF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,SAAS,CAAC,GAAG,CAAC;AACvB,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc,EAAE,iBAA8B;IAC1E,IAAI,kBAAkB,GAAG,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACvD,MAAM,sBAAsB,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC/C,IAAI,OAAO,sBAAsB,KAAK,QAAQ,EAAE,CAAC;QAC/C,kBAAkB,GAAG,iBAAiB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACjD,kBAAkB,GAAG,sBAAsB;aACxC,MAAM,CAAC,CAAC,QAAQ,EAAsB,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/G,CAAC;IAED,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,QAAQ,EAAE,kBAAkB;KAC7B,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,IAAyB,EAAE,KAA0B;IACzF,MAAM,cAAc,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACzG,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,OAAO,sBAAsB,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AAC/D,CAAC"}

package/dist/esm/src/utils/records.js

@@ -24,6 +24,22 @@ export class Records {
             message.descriptor.method === DwnMethodName.Write;
         return isRecordsWrite;
     }
+    /**
+     * Gets the newest `RecordsWrite` from the given message set.
+     */
+    static async getNewestRecordsWrite(messages) {
+        const recordsWriteMessages = messages.filter(Records.isRecordsWrite);
+        const newestRecordsWrite = await Message.getNewestMessage(recordsWriteMessages);
+        return newestRecordsWrite;
+    }
+    /**
+     * Gets the newest `RecordsDelete` from the given message set.
+     */
+    static async getNewestRecordsDelete(messages) {
+        const recordsDeleteMessages = messages.filter((message) => message.descriptor.interface === DwnInterfaceName.Records && message.descriptor.method === DwnMethodName.Delete);
+        const newestRecordsDelete = await Message.getNewestMessage(recordsDeleteMessages);
+        return newestRecordsDelete;
+    }
     // Implementation dispatches based on argument type
     static async decrypt(recordsWrite, keyOrDecrypter, cipherStream) {
         const { encryption } = recordsWrite;
@@ -193,6 +209,23 @@ export class Records {
         removeUndefinedProperties(filterCopy);
         return filterCopy;
     }
+    /**
+     * Nested protocol-path queries must pin one parent context. Otherwise the same
+     * protocol type is read across every parent instance.
+     */
+    static validateNestedProtocolPathQueryScope(filter, errorCode, operationName) {
+        const { contextId, protocolPath } = filter;
+        if (!protocolPath?.includes('/')) {
+            return;
+        }
+        const expectedParentDepth = protocolPath.split('/').length - 1;
+        const contextIdSegments = contextId?.split('/');
+        if (contextIdSegments?.length === expectedParentDepth &&
+            contextIdSegments.every(segment => segment.length > 0)) {
+            return;
+        }
+        throw new DwnError(errorCode, `${operationName} for nested protocol path '${protocolPath}' must include the direct parent contextId in the filter`);
+    }
     static isStartsWithFilter(filter) {
         return typeof filter === 'object' && ('startsWith' in filter && typeof filter.startsWith === 'string');
     }
@@ -380,24 +413,27 @@ export class Records {
         return filter.published === false;
     }
     /**
-     * Checks if the given RecordsDelete message can be performed against a record with the given newest existing state.
+     * Checks whether the given `RecordsDelete` is beaten by an existing tombstone for the record,
+     * per the tombstone lattice. A tombstone displaces any `RecordsWrite` regardless of timestamp
+     * (delete-wins). Among competing tombstones one canonical winner stands on every replica:
+     * a prune beats a plain delete regardless of timestamp — the cascade is a side effect, and a
+     * plain-newer winner would leave replicas that ran the cascade diverged from those that never
+     * would — and within the same class the newest tombstone wins, with `Message.isNewer`'s
+     * (messageTimestamp, CID) total order picking the same winner everywhere. Admission and
+     * resumable-task replay must share this predicate: state can advance between acceptance and
+     * replay, and replay must never admit a delete that admission would now reject.
      */
-    static canPerformDeleteAgainstRecord(deleteToBePerformed, newestExistingMessage) {
-        if (newestExistingMessage === undefined) {
+    static async isDeleteBeatenByExistingTombstone(deleteToBePerformed, newestExistingMessage) {
+        if (newestExistingMessage.descriptor.method !== DwnMethodName.Delete) {
             return false;
         }
-        // can't perform delete if:
-        // attempting to delete on an already deleted record; or
-        // attempting to prune on an already pruned record;
-        if (newestExistingMessage.descriptor.method === DwnMethodName.Delete) {
-            if (deleteToBePerformed.descriptor.prune !== true) {
-                return false;
-            }
-            else if (newestExistingMessage.descriptor.prune === true) {
-                return false;
-            }
+        const incomingIsPrune = deleteToBePerformed.descriptor.prune === true;
+        const existingIsPrune = newestExistingMessage.descriptor.prune === true;
+        if (incomingIsPrune !== existingIsPrune) {
+            return existingIsPrune;
         }
-        return true;
+        const incomingDeleteIsNewest = await Message.isNewer(deleteToBePerformed, newestExistingMessage);
+        return !incomingDeleteIsNewest;
     }
     /**
      * Checks whether or not the incoming records query filter should build an unpublished recipient MessageStore filter.