@openpresentation/opf 0.2.2 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +74 -3
- package/dist/catalogs-x1oFFQnd.d.ts +1198 -0
- package/dist/catalogs.d.ts +2 -32413
- package/dist/catalogs.js +1 -18505
- package/dist/chunk-75N5I6M4.js +229 -0
- package/dist/chunk-EMTMQRX4.js +1007 -0
- package/dist/chunk-GCXOU5MZ.js +6515 -0
- package/dist/chunk-HJNJHB5H.js +454 -0
- package/dist/chunk-OZULJBSG.js +3368 -0
- package/dist/chunk-PIQXLBBJ.js +445 -0
- package/dist/chunk-SOSOBKQ2.js +145 -0
- package/dist/chunk-TWMRZ43O.js +18576 -0
- package/dist/composition.d.ts +190 -0
- package/dist/composition.js +1 -0
- package/dist/data.d.ts +32 -0
- package/dist/data.js +1 -0
- package/dist/docs.d.ts +17 -0
- package/dist/docs.js +120 -0
- package/dist/examples.d.ts +43 -0
- package/dist/examples.js +44828 -0
- package/dist/index.d.ts +7 -4
- package/dist/index.js +8 -29015
- package/dist/pagination.d.ts +52 -0
- package/dist/pagination.js +5 -0
- package/dist/{validator-MwlR2F56.d.ts → presentation-BjP4yTQ1.d.ts} +87 -40
- package/dist/previews.js +1 -447
- package/dist/repo-readme.d.ts +4 -0
- package/dist/repo-readme.js +7 -0
- package/dist/schemas-C1DxapX2.d.ts +206 -0
- package/dist/schemas.d.ts +1 -12373
- package/dist/schemas.js +1 -6275
- package/dist/spec/README.md +57 -0
- package/dist/spec/catalogs/audiences/engineering-team.json +1 -1
- package/dist/spec/catalogs/audiences/index.json +1 -1
- package/dist/spec/catalogs/chart-types/index.json +1 -1
- package/dist/spec/catalogs/color-schemes/index.json +1 -1
- package/dist/spec/catalogs/font-schemes/index.json +1 -1
- package/dist/spec/catalogs/languages/index.json +1 -1
- package/dist/spec/catalogs/layouts/chart-1x.json +4 -1
- package/dist/spec/catalogs/layouts/chart-2x.json +5 -1
- package/dist/spec/catalogs/layouts/chart-3x.json +5 -1
- package/dist/spec/catalogs/layouts/code-1x.json +4 -1
- package/dist/spec/catalogs/layouts/extract/canonical.json +94 -21
- package/dist/spec/catalogs/layouts/image-1x.json +4 -1
- package/dist/spec/catalogs/layouts/image-2x.json +5 -1
- package/dist/spec/catalogs/layouts/image-3x.json +5 -1
- package/dist/spec/catalogs/layouts/index.json +1 -1
- package/dist/spec/catalogs/layouts/list-2x.json +4 -1
- package/dist/spec/catalogs/layouts/list-3x.json +4 -1
- package/dist/spec/catalogs/layouts/list-4x.json +5 -1
- package/dist/spec/catalogs/layouts/list-5x.json +5 -1
- package/dist/spec/catalogs/layouts/list-6x.json +5 -1
- package/dist/spec/catalogs/layouts/media-1x.json +4 -1
- package/dist/spec/catalogs/layouts/number-2x.json +4 -1
- package/dist/spec/catalogs/layouts/number-3x.json +4 -1
- package/dist/spec/catalogs/layouts/number-4x.json +5 -1
- package/dist/spec/catalogs/layouts/number-5x.json +5 -1
- package/dist/spec/catalogs/layouts/number-6x.json +5 -1
- package/dist/spec/catalogs/layouts/table-1x.json +4 -1
- package/dist/spec/catalogs/layouts/text-2x.json +4 -1
- package/dist/spec/catalogs/layouts/text-3x.json +4 -1
- package/dist/spec/catalogs/narratives/index.json +2 -2
- package/dist/spec/catalogs/purposes/index.json +1 -1
- package/dist/spec/catalogs/social-platforms/index.json +1 -1
- package/dist/spec/catalogs/themes/index.json +1 -1
- package/dist/spec/catalogs/tones/casual.json +1 -1
- package/dist/spec/catalogs/tones/conversational.json +1 -1
- package/dist/spec/catalogs/tones/index.json +1 -1
- package/dist/spec/catalogs/tones/technical.json +1 -1
- package/dist/spec/openapi.yaml +66 -26
- package/dist/spec/previews/layouts/index.json +71 -71
- package/dist/spec/schemas/catalog-index.schema.json +53 -0
- package/dist/spec/schemas/layout-preview-index.schema.json +54 -0
- package/dist/spec/schemas/layout.schema.json +63 -0
- package/dist/spec/schemas/opf.schema.json +182 -3
- package/dist/spec-files.d.ts +14 -2386
- package/dist/spec-files.js +1 -3349
- package/dist/types.d.ts +4 -1102
- package/dist/types.js +0 -2
- package/dist/validator.d.ts +33 -3
- package/dist/validator.js +4 -6712
- package/package.json +29 -4
- package/dist/catalogs.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/previews.js.map +0 -1
- package/dist/schemas.js.map +0 -1
- package/dist/spec-files.js.map +0 -1
- package/dist/types.js.map +0 -1
- package/dist/validator.js.map +0 -1
package/dist/types.js
CHANGED
package/dist/validator.d.ts
CHANGED
|
@@ -1,3 +1,33 @@
|
|
|
1
|
-
import './
|
|
2
|
-
|
|
3
|
-
import './schemas.js';
|
|
1
|
+
import { P as Presentation } from './presentation-BjP4yTQ1.js';
|
|
2
|
+
import { c as CatalogKind } from './catalogs-x1oFFQnd.js';
|
|
3
|
+
import { a as SchemaName, J as JsonSchema } from './schemas-C1DxapX2.js';
|
|
4
|
+
|
|
5
|
+
interface ValidationIssue {
|
|
6
|
+
path: string;
|
|
7
|
+
message: string;
|
|
8
|
+
keyword: string;
|
|
9
|
+
schemaPath: string;
|
|
10
|
+
params: Record<string, unknown>;
|
|
11
|
+
}
|
|
12
|
+
interface ValidationResult {
|
|
13
|
+
valid: boolean;
|
|
14
|
+
errors: ValidationIssue[];
|
|
15
|
+
/** Advisory issues such as unknown catalog ids. Warnings never affect `valid`. */
|
|
16
|
+
warnings: ValidationIssue[];
|
|
17
|
+
schemaName?: SchemaName;
|
|
18
|
+
catalogKind?: CatalogKind;
|
|
19
|
+
}
|
|
20
|
+
type SchemaOrKind = SchemaName | CatalogKind | JsonSchema;
|
|
21
|
+
declare class OPFValidationError extends Error {
|
|
22
|
+
readonly issues: ValidationIssue[];
|
|
23
|
+
readonly result: ValidationResult;
|
|
24
|
+
constructor(result: ValidationResult);
|
|
25
|
+
}
|
|
26
|
+
declare function validate(value: unknown, schemaOrKind?: SchemaOrKind): ValidationResult;
|
|
27
|
+
declare function assertValid<T = unknown>(value: T, schemaOrKind?: SchemaOrKind): T;
|
|
28
|
+
declare function validatePresentation(value: unknown): ValidationResult;
|
|
29
|
+
declare function assertValidPresentation(value: unknown): asserts value is Presentation;
|
|
30
|
+
declare function validateCatalogRecord(kind: CatalogKind, value: unknown): ValidationResult;
|
|
31
|
+
declare function assertValidCatalogRecord(kind: CatalogKind, value: unknown): void;
|
|
32
|
+
|
|
33
|
+
export { OPFValidationError, type SchemaOrKind, type ValidationIssue, type ValidationResult, assertValid, assertValidCatalogRecord, assertValidPresentation, validate, validateCatalogRecord, validatePresentation };
|