@endora-commerce/contracts 0.106.0 → 0.107.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/dist/admin-contributions.d.ts +11 -6
- package/dist/admin-contributions.d.ts.map +1 -1
- package/dist/admin-contributions.js +9 -6
- package/dist/admin-contributions.js.map +1 -1
- package/dist/admin-roles.d.ts +32 -2
- package/dist/admin-roles.d.ts.map +1 -1
- package/dist/admin-roles.js +21 -1
- package/dist/admin-roles.js.map +1 -1
- package/dist/admin-search.d.ts +655 -0
- package/dist/admin-search.d.ts.map +1 -0
- package/dist/admin-search.js +179 -0
- package/dist/admin-search.js.map +1 -0
- package/dist/analytics.d.ts +5 -0
- package/dist/analytics.d.ts.map +1 -1
- package/dist/analytics.js +8 -0
- package/dist/analytics.js.map +1 -1
- package/dist/api-keys.d.ts +6 -0
- package/dist/api-keys.d.ts.map +1 -1
- package/dist/api-keys.js +5 -0
- package/dist/api-keys.js.map +1 -1
- package/dist/assets-library.d.ts +102 -0
- package/dist/assets-library.d.ts.map +1 -1
- package/dist/assets-library.js +89 -0
- package/dist/assets-library.js.map +1 -1
- package/dist/auth.d.ts +20 -0
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +20 -0
- package/dist/auth.js.map +1 -1
- package/dist/blog.d.ts +1 -1
- package/dist/carts.d.ts +21 -6
- package/dist/carts.d.ts.map +1 -1
- package/dist/catalog.d.ts +58 -6
- package/dist/catalog.d.ts.map +1 -1
- package/dist/catalog.js +31 -0
- package/dist/catalog.js.map +1 -1
- package/dist/cms.d.ts +183 -3
- package/dist/cms.d.ts.map +1 -1
- package/dist/cms.js +132 -1
- package/dist/cms.js.map +1 -1
- package/dist/comparisons.d.ts +73 -0
- package/dist/comparisons.d.ts.map +1 -1
- package/dist/comparisons.js +22 -0
- package/dist/comparisons.js.map +1 -1
- package/dist/credentials.d.ts +23 -0
- package/dist/credentials.d.ts.map +1 -1
- package/dist/credentials.js +24 -0
- package/dist/credentials.js.map +1 -1
- package/dist/crm.d.ts +1 -1
- package/dist/custom-fields.d.ts +3 -3
- package/dist/customer-accounts.d.ts +92 -2
- package/dist/customer-accounts.d.ts.map +1 -1
- package/dist/document-templates.d.ts +1192 -0
- package/dist/document-templates.d.ts.map +1 -0
- package/dist/document-templates.js +472 -0
- package/dist/document-templates.js.map +1 -0
- package/dist/document-values.d.ts +156 -0
- package/dist/document-values.d.ts.map +1 -0
- package/dist/document-values.js +208 -0
- package/dist/document-values.js.map +1 -0
- package/dist/errors.d.ts +93 -0
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +114 -0
- package/dist/errors.js.map +1 -1
- package/dist/import-export.d.ts +11 -0
- package/dist/import-export.d.ts.map +1 -1
- package/dist/import-export.js +9 -0
- package/dist/import-export.js.map +1 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +12 -1
- package/dist/index.js.map +1 -1
- package/dist/invoice-ledger.d.ts +6 -6
- package/dist/invoices.d.ts +88 -0
- package/dist/invoices.d.ts.map +1 -1
- package/dist/invoices.js +12 -0
- package/dist/invoices.js.map +1 -1
- package/dist/mfa.d.ts +20 -0
- package/dist/mfa.d.ts.map +1 -1
- package/dist/modules.d.ts +20 -10
- package/dist/modules.d.ts.map +1 -1
- package/dist/newsletter.d.ts +2 -0
- package/dist/newsletter.d.ts.map +1 -1
- package/dist/newsletter.js +4 -0
- package/dist/newsletter.js.map +1 -1
- package/dist/orders.d.ts +32 -1
- package/dist/orders.d.ts.map +1 -1
- package/dist/orders.js +33 -17
- package/dist/orders.js.map +1 -1
- package/dist/organizations.d.ts +78 -0
- package/dist/organizations.d.ts.map +1 -1
- package/dist/organizations.js +54 -0
- package/dist/organizations.js.map +1 -1
- package/dist/payment-methods.d.ts +2 -2
- package/dist/price-lists.d.ts +491 -2
- package/dist/price-lists.d.ts.map +1 -1
- package/dist/price-lists.js +255 -0
- package/dist/price-lists.js.map +1 -1
- package/dist/product-feeds.d.ts +13 -13
- package/dist/prompt-actions.d.ts +25 -6
- package/dist/prompt-actions.d.ts.map +1 -1
- package/dist/prompt-actions.js +17 -1
- package/dist/prompt-actions.js.map +1 -1
- package/dist/pwa.d.ts +25 -0
- package/dist/pwa.d.ts.map +1 -1
- package/dist/pwa.js +38 -0
- package/dist/pwa.js.map +1 -1
- package/dist/quote-requests.d.ts +633 -8
- package/dist/quote-requests.d.ts.map +1 -1
- package/dist/quote-requests.js +365 -2
- package/dist/quote-requests.js.map +1 -1
- package/dist/sales-channels.d.ts +46 -0
- package/dist/sales-channels.d.ts.map +1 -1
- package/dist/sales-channels.js +40 -0
- package/dist/sales-channels.js.map +1 -1
- package/dist/saved-list-views.d.ts +140 -0
- package/dist/saved-list-views.d.ts.map +1 -0
- package/dist/saved-list-views.js +108 -0
- package/dist/saved-list-views.js.map +1 -0
- package/dist/search.d.ts +6 -0
- package/dist/search.d.ts.map +1 -1
- package/dist/seo.d.ts +2 -0
- package/dist/seo.d.ts.map +1 -1
- package/dist/seo.js +11 -0
- package/dist/seo.js.map +1 -1
- package/dist/shipping-methods.d.ts +2 -2
- package/package.json +1 -1
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
// Admin global search (`specs/150-admin-global-search/`).
|
|
2
|
+
//
|
|
3
|
+
// Two halves, one file, because they describe one seam:
|
|
4
|
+
//
|
|
5
|
+
// * the HTTP shapes `admin_search` answers on `/api/v1/admin/global-search*`
|
|
6
|
+
// and the admin shell parses with (`contracts/admin-search-api.md`);
|
|
7
|
+
// * the provider contract an owning module implements to make its records
|
|
8
|
+
// findable (`contracts/provider-contract.md`). The host never names a
|
|
9
|
+
// provider module, never reads a provider's table and never imports a
|
|
10
|
+
// provider's class: each owner pushes an `AdminSearchProvider` built over its
|
|
11
|
+
// own services into `adminSearchProviderRegistry`.
|
|
12
|
+
import { z } from 'zod';
|
|
13
|
+
import { KnownIconNameSchema } from './admin-actions.js';
|
|
14
|
+
import { SupportedAdminLanguageSchema } from './admin-i18n.js';
|
|
15
|
+
// ---------------------------------------------------------------------------
|
|
16
|
+
// Identifiers
|
|
17
|
+
// ---------------------------------------------------------------------------
|
|
18
|
+
/** `<moduleId>.<snake_name>`, e.g. `orders.order`. */
|
|
19
|
+
export const AdminSearchEntityTypeSchema = z
|
|
20
|
+
.string()
|
|
21
|
+
.max(128)
|
|
22
|
+
.regex(/^[a-z][a-z0-9_]*\.[a-z][a-z0-9_]*$/, 'Entity type must be <moduleId>.<snake_name>');
|
|
23
|
+
/** camelCase, unique within one provider. */
|
|
24
|
+
export const AdminSearchFieldCodeSchema = z
|
|
25
|
+
.string()
|
|
26
|
+
.max(40)
|
|
27
|
+
.regex(/^[a-z][a-zA-Z0-9]*$/, 'Field code must be camelCase');
|
|
28
|
+
/**
|
|
29
|
+
* A module-relative translation key (`adminSearch.field.number`). The grammar
|
|
30
|
+
* of a palette action's `labelKey`: a flat bundle key, dot-separated camelCase
|
|
31
|
+
* segments.
|
|
32
|
+
*/
|
|
33
|
+
export const AdminSearchLabelKeySchema = z
|
|
34
|
+
.string()
|
|
35
|
+
.min(1)
|
|
36
|
+
.max(255)
|
|
37
|
+
.regex(/^[a-z][a-zA-Z0-9_]*(\.[a-z][a-zA-Z0-9_]*)*$/, 'Translation key must be dot-separated camelCase');
|
|
38
|
+
/** Most fields one record type may offer. */
|
|
39
|
+
export const ADMIN_SEARCH_MAX_FIELDS = 20;
|
|
40
|
+
/** Most record types one stored configuration may carry. */
|
|
41
|
+
export const ADMIN_SEARCH_MAX_ENTITY_TYPES = 64;
|
|
42
|
+
/** Longest search text accepted (FR-012). */
|
|
43
|
+
export const ADMIN_SEARCH_MAX_QUERY_LENGTH = 100;
|
|
44
|
+
/** Most results one record type may be asked for (the results page asks 20). */
|
|
45
|
+
export const ADMIN_SEARCH_MAX_LIMIT = 25;
|
|
46
|
+
// ---------------------------------------------------------------------------
|
|
47
|
+
// HTTP: capability
|
|
48
|
+
// ---------------------------------------------------------------------------
|
|
49
|
+
/** `GET /api/v1/admin/global-search/capability` — what the palette needs once per open. */
|
|
50
|
+
export const AdminSearchCapabilitySchema = z.object({
|
|
51
|
+
minimumQueryLength: z.number().int().min(2).max(10),
|
|
52
|
+
resultsPerEntity: z.number().int().min(1).max(10),
|
|
53
|
+
/** The entity types this caller would get results for right now (present ∧ permitted ∧ enabled). */
|
|
54
|
+
entityTypes: z.array(z.object({
|
|
55
|
+
entityType: AdminSearchEntityTypeSchema,
|
|
56
|
+
label: z.string(),
|
|
57
|
+
icon: KnownIconNameSchema,
|
|
58
|
+
})),
|
|
59
|
+
});
|
|
60
|
+
export const AdminSearchCapabilityQuerySchema = z.object({
|
|
61
|
+
language: SupportedAdminLanguageSchema,
|
|
62
|
+
});
|
|
63
|
+
// ---------------------------------------------------------------------------
|
|
64
|
+
// HTTP: search
|
|
65
|
+
// ---------------------------------------------------------------------------
|
|
66
|
+
/** `GET /api/v1/admin/global-search` query string. */
|
|
67
|
+
export const AdminSearchQuerySchema = z.object({
|
|
68
|
+
/** Trimmed server-side; longer than 100 characters is refused. */
|
|
69
|
+
q: z.string().max(ADMIN_SEARCH_MAX_QUERY_LENGTH),
|
|
70
|
+
/** Comma-separated in the query string. */
|
|
71
|
+
entityTypes: z
|
|
72
|
+
.string()
|
|
73
|
+
.optional()
|
|
74
|
+
.transform((s) => (s ? s.split(',').filter(Boolean) : undefined))
|
|
75
|
+
.pipe(z.array(AdminSearchEntityTypeSchema).max(16).optional()),
|
|
76
|
+
/** Default: the `admin_search.results_per_entity` setting. */
|
|
77
|
+
limit: z.coerce.number().int().min(1).max(ADMIN_SEARCH_MAX_LIMIT).optional(),
|
|
78
|
+
language: SupportedAdminLanguageSchema,
|
|
79
|
+
});
|
|
80
|
+
/**
|
|
81
|
+
* An admin path, optionally with a query string (category focus). Never an
|
|
82
|
+
* absolute URL and never protocol-relative: the shell navigates to it.
|
|
83
|
+
*/
|
|
84
|
+
export const AdminSearchTargetRouteSchema = z
|
|
85
|
+
.string()
|
|
86
|
+
.max(512)
|
|
87
|
+
.regex(/^\/(?!\/)[A-Za-z0-9\-._~/:%]*(\?[A-Za-z0-9\-._~=&%]*)?$/, 'Target route must be an admin path');
|
|
88
|
+
export const AdminSearchHitSchema = z.object({
|
|
89
|
+
id: z.string(),
|
|
90
|
+
title: z.string(),
|
|
91
|
+
subtitle: z.string().nullable(),
|
|
92
|
+
status: z.object({ code: z.string(), label: z.string() }).nullable(),
|
|
93
|
+
targetRoute: AdminSearchTargetRouteSchema,
|
|
94
|
+
});
|
|
95
|
+
export const AdminSearchGroupStatusSchema = z.enum(['ok', 'timed_out', 'failed']);
|
|
96
|
+
export const AdminSearchGroupSchema = z.object({
|
|
97
|
+
entityType: AdminSearchEntityTypeSchema,
|
|
98
|
+
label: z.string(),
|
|
99
|
+
icon: KnownIconNameSchema,
|
|
100
|
+
status: AdminSearchGroupStatusSchema,
|
|
101
|
+
/** Empty unless `status === 'ok'`. */
|
|
102
|
+
hits: z.array(AdminSearchHitSchema),
|
|
103
|
+
hasMore: z.boolean(),
|
|
104
|
+
});
|
|
105
|
+
export const AdminSearchResultSchema = z.object({
|
|
106
|
+
/** The trimmed text actually searched. */
|
|
107
|
+
query: z.string(),
|
|
108
|
+
groups: z.array(AdminSearchGroupSchema),
|
|
109
|
+
});
|
|
110
|
+
export const AdminSearchResponseMetaSchema = z.object({
|
|
111
|
+
belowMinimumLength: z.boolean(),
|
|
112
|
+
minimumQueryLength: z.number().int(),
|
|
113
|
+
limit: z.number().int(),
|
|
114
|
+
tookMs: z.number().int().nonnegative(),
|
|
115
|
+
});
|
|
116
|
+
export const AdminSearchResponseSchema = z.object({
|
|
117
|
+
data: AdminSearchResultSchema,
|
|
118
|
+
meta: AdminSearchResponseMetaSchema,
|
|
119
|
+
});
|
|
120
|
+
// ---------------------------------------------------------------------------
|
|
121
|
+
// HTTP: configuration
|
|
122
|
+
// ---------------------------------------------------------------------------
|
|
123
|
+
export const AdminSearchConfigurationFieldViewSchema = z.object({
|
|
124
|
+
code: AdminSearchFieldCodeSchema,
|
|
125
|
+
label: z.string(),
|
|
126
|
+
selected: z.boolean(),
|
|
127
|
+
defaultSelected: z.boolean(),
|
|
128
|
+
});
|
|
129
|
+
export const AdminSearchConfigurationEntityViewSchema = z.object({
|
|
130
|
+
entityType: AdminSearchEntityTypeSchema,
|
|
131
|
+
label: z.string(),
|
|
132
|
+
icon: KnownIconNameSchema,
|
|
133
|
+
enabled: z.boolean(),
|
|
134
|
+
/** `false` ⇔ no stored entry (the defaults apply). */
|
|
135
|
+
customized: z.boolean(),
|
|
136
|
+
fields: z.array(AdminSearchConfigurationFieldViewSchema),
|
|
137
|
+
});
|
|
138
|
+
/** `GET /api/v1/admin/global-search/configuration`. */
|
|
139
|
+
export const AdminSearchConfigurationViewSchema = z.object({
|
|
140
|
+
/** Settings' optimistic-lock token, `''` before the first write. */
|
|
141
|
+
version: z.string(),
|
|
142
|
+
minimumQueryLength: z.number().int(),
|
|
143
|
+
resultsPerEntity: z.number().int(),
|
|
144
|
+
entities: z.array(AdminSearchConfigurationEntityViewSchema),
|
|
145
|
+
});
|
|
146
|
+
/** `PUT /api/v1/admin/global-search/configuration`. */
|
|
147
|
+
export const UpdateAdminSearchConfigurationRequestSchema = z.object({
|
|
148
|
+
/** `null` only for the first write. */
|
|
149
|
+
expectedVersion: z.string().nullable(),
|
|
150
|
+
entities: z
|
|
151
|
+
.array(z.object({
|
|
152
|
+
entityType: AdminSearchEntityTypeSchema,
|
|
153
|
+
/** Omit both `enabled` and `fields` to restore the defaults (the stored entry is removed). */
|
|
154
|
+
enabled: z.boolean().optional(),
|
|
155
|
+
fields: z.array(AdminSearchFieldCodeSchema).max(ADMIN_SEARCH_MAX_FIELDS).optional(),
|
|
156
|
+
}))
|
|
157
|
+
.max(ADMIN_SEARCH_MAX_ENTITY_TYPES),
|
|
158
|
+
});
|
|
159
|
+
// ---------------------------------------------------------------------------
|
|
160
|
+
// Stored configuration (`admin_search.entity_fields`, a hidden `json` Setting)
|
|
161
|
+
// ---------------------------------------------------------------------------
|
|
162
|
+
export const AdminSearchStoredEntityConfigurationSchema = z.object({
|
|
163
|
+
enabled: z.boolean(),
|
|
164
|
+
fields: z.array(AdminSearchFieldCodeSchema).max(ADMIN_SEARCH_MAX_FIELDS),
|
|
165
|
+
});
|
|
166
|
+
export const AdminSearchStoredConfigurationSchema = z.object({
|
|
167
|
+
version: z.literal(1),
|
|
168
|
+
entities: z
|
|
169
|
+
.record(AdminSearchEntityTypeSchema, AdminSearchStoredEntityConfigurationSchema)
|
|
170
|
+
.refine((v) => Object.keys(v).length <= ADMIN_SEARCH_MAX_ENTITY_TYPES, {
|
|
171
|
+
message: `At most ${ADMIN_SEARCH_MAX_ENTITY_TYPES} entity types`,
|
|
172
|
+
}),
|
|
173
|
+
});
|
|
174
|
+
/** The shipped value of `admin_search.entity_fields`: every provider's defaults apply. */
|
|
175
|
+
export const ADMIN_SEARCH_DEFAULT_STORED_CONFIGURATION = {
|
|
176
|
+
version: 1,
|
|
177
|
+
entities: {},
|
|
178
|
+
};
|
|
179
|
+
//# sourceMappingURL=admin-search.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"admin-search.js","sourceRoot":"","sources":["../src/admin-search.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,EAAE;AACF,wDAAwD;AACxD,EAAE;AACF,8EAA8E;AAC9E,wEAAwE;AACxE,2EAA2E;AAC3E,yEAAyE;AACzE,yEAAyE;AACzE,iFAAiF;AACjF,sDAAsD;AAEtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAsB,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAE,4BAA4B,EAA+B,MAAM,iBAAiB,CAAC;AAE5F,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAE9E,sDAAsD;AACtD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,CAAC;KACR,KAAK,CAAC,oCAAoC,EAAE,6CAA6C,CAAC,CAAC;AAE9F,6CAA6C;AAC7C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,EAAE;KACR,GAAG,CAAC,EAAE,CAAC;KACP,KAAK,CAAC,qBAAqB,EAAE,8BAA8B,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,GAAG,CAAC;KACR,KAAK,CAAC,6CAA6C,EAAE,iDAAiD,CAAC,CAAC;AAE3G,6CAA6C;AAC7C,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAC1C,4DAA4D;AAC5D,MAAM,CAAC,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAChD,6CAA6C;AAC7C,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAAG,CAAC;AACjD,gFAAgF;AAChF,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAE9E,2FAA2F;AAC3F,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACnD,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACjD,oGAAoG;IACpG,WAAW,EAAE,CAAC,CAAC,KAAK,CAClB,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,2BAA2B;QACvC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,mBAAmB;KAC1B,CAAC,CACH;CACF,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,QAAQ,EAAE,4BAA4B;CACvC,CAAC,CAAC;AAEH,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,kEAAkE;IAClE,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,6BAA6B,CAAC;IAChD,2CAA2C;IAC3C,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SAChE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;IAChE,8DAA8D;IAC9D,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IAC5E,QAAQ,EAAE,4BAA4B;CACvC,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,CAAC;KACR,KAAK,CAAC,yDAAyD,EAAE,oCAAoC,CAAC,CAAC;AAE1G,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpE,WAAW,EAAE,4BAA4B;CAC1C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGlF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,2BAA2B;IACvC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,mBAAmB;IACzB,MAAM,EAAE,4BAA4B;IACpC,sCAAsC;IACtC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,0CAA0C;IAC1C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC/B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CACvC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,6BAA6B;CACpC,CAAC,CAAC;AAGH,8EAA8E;AAC9E,sBAAsB;AACtB,8EAA8E;AAE9E,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9D,IAAI,EAAE,0BAA0B;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE;CAC7B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/D,UAAU,EAAE,2BAA2B;IACvC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,mBAAmB;IACzB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,sDAAsD;IACtD,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,uCAAuC,CAAC;CACzD,CAAC,CAAC;AAKH,uDAAuD;AACvD,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,oEAAoE;IACpE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACpC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwC,CAAC;CAC5D,CAAC,CAAC;AAGH,uDAAuD;AACvD,MAAM,CAAC,MAAM,2CAA2C,GAAG,CAAC,CAAC,MAAM,CAAC;IAClE,uCAAuC;IACvC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,2BAA2B;QACvC,8FAA8F;QAC9F,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC/B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE;KACpF,CAAC,CACH;SACA,GAAG,CAAC,6BAA6B,CAAC;CACtC,CAAC,CAAC;AAKH,8EAA8E;AAC9E,+EAA+E;AAC/E,8EAA8E;AAE9E,MAAM,CAAC,MAAM,0CAA0C,GAAG,CAAC,CAAC,MAAM,CAAC;IACjE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC;CACzE,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACrB,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,2BAA2B,EAAE,0CAA0C,CAAC;SAC/E,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,6BAA6B,EAAE;QACrE,OAAO,EAAE,WAAW,6BAA6B,eAAe;KACjE,CAAC;CACL,CAAC,CAAC;AAGH,0FAA0F;AAC1F,MAAM,CAAC,MAAM,yCAAyC,GAAmC;IACvF,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,EAAE;CACb,CAAC"}
|
package/dist/analytics.d.ts
CHANGED
|
@@ -20,6 +20,11 @@ export type AnalyticsEventType = z.infer<typeof analyticsEventTypeSchema>;
|
|
|
20
20
|
/**
|
|
21
21
|
* A single inbound analytics event. The shape is intentionally permissive
|
|
22
22
|
* inside `properties` — the storefront chooses what to send per event type.
|
|
23
|
+
*
|
|
24
|
+
* `salesChannelId`, `customerAccountId` and `organizationId` are accepted so
|
|
25
|
+
* existing senders keep validating, but the server ignores them: a stored event
|
|
26
|
+
* carries the channel the request resolved to and the identity of the signed-in
|
|
27
|
+
* customer, if any.
|
|
23
28
|
*/
|
|
24
29
|
export declare const ingestAnalyticsEventSchema: z.ZodObject<{
|
|
25
30
|
type: z.ZodEnum<{
|
package/dist/analytics.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;GAOG;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;EAQnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E
|
|
1
|
+
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;GAOG;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;EAQnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;iBAWrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;iBAE5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F,eAAO,MAAM,kCAAkC;;;;;;iBAU7C,CAAC;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;iBAItC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;iBAIpC,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC"}
|
package/dist/analytics.js
CHANGED
|
@@ -20,12 +20,20 @@ export const analyticsEventTypeSchema = z.enum([
|
|
|
20
20
|
/**
|
|
21
21
|
* A single inbound analytics event. The shape is intentionally permissive
|
|
22
22
|
* inside `properties` — the storefront chooses what to send per event type.
|
|
23
|
+
*
|
|
24
|
+
* `salesChannelId`, `customerAccountId` and `organizationId` are accepted so
|
|
25
|
+
* existing senders keep validating, but the server ignores them: a stored event
|
|
26
|
+
* carries the channel the request resolved to and the identity of the signed-in
|
|
27
|
+
* customer, if any.
|
|
23
28
|
*/
|
|
24
29
|
export const ingestAnalyticsEventSchema = z.object({
|
|
25
30
|
type: analyticsEventTypeSchema,
|
|
26
31
|
occurredAt: isoDateTimeSchema.optional(),
|
|
32
|
+
/** @deprecated Ignored; the server uses the resolved request channel. */
|
|
27
33
|
salesChannelId: uuidSchema.optional(),
|
|
34
|
+
/** @deprecated Ignored; the server uses the signed-in customer, if any. */
|
|
28
35
|
customerAccountId: uuidSchema.optional(),
|
|
36
|
+
/** @deprecated Ignored; the server uses the signed-in customer's organization, if any. */
|
|
29
37
|
organizationId: uuidSchema.optional(),
|
|
30
38
|
sessionId: z.string().min(1).max(64).optional(),
|
|
31
39
|
properties: z.record(z.string(), z.unknown()).optional(),
|
package/dist/analytics.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE5D;;;;;;;GAOG;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC7C,gBAAgB;IAChB,uBAAuB;IACvB,gBAAgB;IAChB,cAAc;IACd,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;CAClB,CAAC,CAAC;AAGH
|
|
1
|
+
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE5D;;;;;;;GAOG;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC7C,gBAAgB;IAChB,uBAAuB;IACvB,gBAAgB;IAChB,cAAc;IACd,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;CAClB,CAAC,CAAC;AAGH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,wBAAwB;IAC9B,UAAU,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACxC,yEAAyE;IACzE,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;IACrC,2EAA2E;IAC3E,iBAAiB,EAAE,UAAU,CAAC,QAAQ,EAAE;IACxC,0FAA0F;IAC1F,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CAC5D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACxC,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;QACrC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;KACnB,CAAC,CACH;SACA,OAAO,CAAC,EAAE,CAAC;CACf,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,iBAAiB;IACvB,EAAE,EAAE,iBAAiB;IACrB,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,EAAE,YAAY,CAAC;IAC1D,IAAI,EAAE,wBAAwB;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,YAAY,EAAE,CAAC,CAAC,KAAK,CACnB,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,wBAAwB;QAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;KACtC,CAAC,CACH;IACD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC;CAC1C,CAAC,CAAC"}
|
package/dist/api-keys.d.ts
CHANGED
|
@@ -18,12 +18,17 @@ export type ApiKeyStatus = z.infer<typeof apiKeyStatusSchema>;
|
|
|
18
18
|
* - `catalog:write` — PIM by-SKU upsert — UNBOUND KEYS ONLY
|
|
19
19
|
* - `orders:read` — distributor order reads — BOUND KEYS ONLY
|
|
20
20
|
* - `orders:write` — distributor order intake — BOUND KEYS ONLY
|
|
21
|
+
* - `platform.api_description.read` — the API description
|
|
22
|
+
* (`GET /api/v1/_openapi.json`, `GET /api/v1/_docs`); the same code an
|
|
23
|
+
* administrator's role holds to read it, and like every scope it can be
|
|
24
|
+
* issued only by an administrator who holds it
|
|
21
25
|
*/
|
|
22
26
|
export declare const apiKeyScopeSchema: z.ZodEnum<{
|
|
23
27
|
"catalog:read": "catalog:read";
|
|
24
28
|
"catalog:write": "catalog:write";
|
|
25
29
|
"orders:read": "orders:read";
|
|
26
30
|
"orders:write": "orders:write";
|
|
31
|
+
"platform.api_description.read": "platform.api_description.read";
|
|
27
32
|
}>;
|
|
28
33
|
export type ApiKeyScope = z.infer<typeof apiKeyScopeSchema>;
|
|
29
34
|
/**
|
|
@@ -63,6 +68,7 @@ export declare const createApiKeyRequestSchema: z.ZodObject<{
|
|
|
63
68
|
"catalog:write": "catalog:write";
|
|
64
69
|
"orders:read": "orders:read";
|
|
65
70
|
"orders:write": "orders:write";
|
|
71
|
+
"platform.api_description.read": "platform.api_description.read";
|
|
66
72
|
}>>;
|
|
67
73
|
binding: z.ZodOptional<z.ZodObject<{
|
|
68
74
|
organizationId: z.ZodString;
|
package/dist/api-keys.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../src/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;GAIG;AAEH,eAAO,MAAM,kBAAkB;;;EAAgC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D
|
|
1
|
+
{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../src/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;GAIG;AAEH,eAAO,MAAM,kBAAkB;;;EAAgC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB;;;;;;EAM5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;iBAK9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;iBAgBvB,CAAC;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAElD,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;iBAKpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;iBAIrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}
|
package/dist/api-keys.js
CHANGED
|
@@ -15,12 +15,17 @@ export const apiKeyStatusSchema = z.enum(['active', 'revoked']);
|
|
|
15
15
|
* - `catalog:write` — PIM by-SKU upsert — UNBOUND KEYS ONLY
|
|
16
16
|
* - `orders:read` — distributor order reads — BOUND KEYS ONLY
|
|
17
17
|
* - `orders:write` — distributor order intake — BOUND KEYS ONLY
|
|
18
|
+
* - `platform.api_description.read` — the API description
|
|
19
|
+
* (`GET /api/v1/_openapi.json`, `GET /api/v1/_docs`); the same code an
|
|
20
|
+
* administrator's role holds to read it, and like every scope it can be
|
|
21
|
+
* issued only by an administrator who holds it
|
|
18
22
|
*/
|
|
19
23
|
export const apiKeyScopeSchema = z.enum([
|
|
20
24
|
'catalog:read',
|
|
21
25
|
'catalog:write',
|
|
22
26
|
'orders:read',
|
|
23
27
|
'orders:write',
|
|
28
|
+
'platform.api_description.read',
|
|
24
29
|
]);
|
|
25
30
|
/**
|
|
26
31
|
* Distributor binding (feature 062, contracts/api-key-binding.md §2).
|
package/dist/api-keys.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../src/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE5D;;;;GAIG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAGhE
|
|
1
|
+
{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../src/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE5D;;;;GAIG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAGhE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC;IACtC,cAAc;IACd,eAAe;IACf,aAAa;IACb,cAAc;IACd,+BAA+B;CAChC,CAAC,CAAC;AAGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,cAAc,EAAE,UAAU;IAC1B,cAAc,EAAE,UAAU;IAC1B,+EAA+E;IAC/E,iBAAiB,EAAE,UAAU;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,EAAE,EAAE,UAAU;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,MAAM,EAAE,kBAAkB;IAC1B,UAAU,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,iBAAiB;IAC5B,SAAS,EAAE,iBAAiB;IAC5B,yEAAyE;IACzE,+BAA+B;IAC/B,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;IACrC,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;IACrC,iBAAiB,EAAE,UAAU,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,iBAAiB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,iBAAiB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,MAAM,EAAE,YAAY;IACpB,4DAA4D;IAC5D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC"}
|
package/dist/assets-library.d.ts
CHANGED
|
@@ -72,6 +72,17 @@ export declare const listFoldersResponseSchema: z.ZodObject<{
|
|
|
72
72
|
}, z.core.$strip>>;
|
|
73
73
|
}, z.core.$strip>;
|
|
74
74
|
export type ListFoldersResponse = z.infer<typeof listFoldersResponseSchema>;
|
|
75
|
+
/**
|
|
76
|
+
* `GET /api/v1/admin/assets/folders/:folderId/permalink-count` — how many live
|
|
77
|
+
* assets in the folder's subtree have a permalink, named by the folder delete
|
|
78
|
+
* confirmation (specs/156-asset-stable-url/, owner ruling S4).
|
|
79
|
+
*/
|
|
80
|
+
export declare const folderPermalinkCountResponseSchema: z.ZodObject<{
|
|
81
|
+
data: z.ZodObject<{
|
|
82
|
+
permalinkedAssets: z.ZodNumber;
|
|
83
|
+
}, z.core.$strip>;
|
|
84
|
+
}, z.core.$strip>;
|
|
85
|
+
export type FolderPermalinkCountResponse = z.infer<typeof folderPermalinkCountResponseSchema>;
|
|
75
86
|
export declare const createFolderRequestSchema: z.ZodObject<{
|
|
76
87
|
parentId: z.ZodNullable<z.ZodString>;
|
|
77
88
|
name: z.ZodString;
|
|
@@ -126,8 +137,26 @@ export declare const assetSummarySchema: z.ZodObject<{
|
|
|
126
137
|
updatedAt: z.ZodString;
|
|
127
138
|
deletedAt: z.ZodNullable<z.ZodString>;
|
|
128
139
|
pendingCleanup: z.ZodBoolean;
|
|
140
|
+
fileUrl: z.ZodString;
|
|
141
|
+
permalink: z.ZodNullable<z.ZodString>;
|
|
142
|
+
permalinkUrl: z.ZodNullable<z.ZodString>;
|
|
143
|
+
contentVersion: z.ZodString;
|
|
129
144
|
}, z.core.$strip>;
|
|
130
145
|
export type AssetSummary = z.infer<typeof assetSummarySchema>;
|
|
146
|
+
/** The one kept previous version of an asset's file, as the detail panel shows it. */
|
|
147
|
+
export declare const assetPreviousVersionSchema: z.ZodObject<{
|
|
148
|
+
filename: z.ZodString;
|
|
149
|
+
mimeType: z.ZodString;
|
|
150
|
+
sizeBytes: z.ZodNumber;
|
|
151
|
+
contentVersion: z.ZodString;
|
|
152
|
+
replacedAt: z.ZodString;
|
|
153
|
+
replacedBy: z.ZodNullable<z.ZodObject<{
|
|
154
|
+
id: z.ZodString;
|
|
155
|
+
displayName: z.ZodString;
|
|
156
|
+
}, z.core.$strip>>;
|
|
157
|
+
restorableUntil: z.ZodString;
|
|
158
|
+
}, z.core.$strip>;
|
|
159
|
+
export type AssetPreviousVersion = z.infer<typeof assetPreviousVersionSchema>;
|
|
131
160
|
/** Detail extends summary with multilingual alt text + the deletion-protection list. */
|
|
132
161
|
export declare const assetDetailSchema: z.ZodObject<{
|
|
133
162
|
id: z.ZodString;
|
|
@@ -151,6 +180,10 @@ export declare const assetDetailSchema: z.ZodObject<{
|
|
|
151
180
|
updatedAt: z.ZodString;
|
|
152
181
|
deletedAt: z.ZodNullable<z.ZodString>;
|
|
153
182
|
pendingCleanup: z.ZodBoolean;
|
|
183
|
+
fileUrl: z.ZodString;
|
|
184
|
+
permalink: z.ZodNullable<z.ZodString>;
|
|
185
|
+
permalinkUrl: z.ZodNullable<z.ZodString>;
|
|
186
|
+
contentVersion: z.ZodString;
|
|
154
187
|
altText: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
155
188
|
references: z.ZodArray<z.ZodObject<{
|
|
156
189
|
kind: z.ZodEnum<{
|
|
@@ -169,6 +202,20 @@ export declare const assetDetailSchema: z.ZodObject<{
|
|
|
169
202
|
entityId: z.ZodString;
|
|
170
203
|
label: z.ZodString;
|
|
171
204
|
}, z.core.$strip>>;
|
|
205
|
+
previousVersion: z.ZodNullable<z.ZodObject<{
|
|
206
|
+
filename: z.ZodString;
|
|
207
|
+
mimeType: z.ZodString;
|
|
208
|
+
sizeBytes: z.ZodNumber;
|
|
209
|
+
contentVersion: z.ZodString;
|
|
210
|
+
replacedAt: z.ZodString;
|
|
211
|
+
replacedBy: z.ZodNullable<z.ZodObject<{
|
|
212
|
+
id: z.ZodString;
|
|
213
|
+
displayName: z.ZodString;
|
|
214
|
+
}, z.core.$strip>>;
|
|
215
|
+
restorableUntil: z.ZodString;
|
|
216
|
+
}, z.core.$strip>>;
|
|
217
|
+
retentionDays: z.ZodNumber;
|
|
218
|
+
replaceable: z.ZodBoolean;
|
|
172
219
|
}, z.core.$strip>;
|
|
173
220
|
export type AssetDetail = z.infer<typeof assetDetailSchema>;
|
|
174
221
|
export declare const listAssetsQuerySchema: z.ZodObject<{
|
|
@@ -207,6 +254,10 @@ export declare const listAssetsResponseSchema: z.ZodObject<{
|
|
|
207
254
|
updatedAt: z.ZodString;
|
|
208
255
|
deletedAt: z.ZodNullable<z.ZodString>;
|
|
209
256
|
pendingCleanup: z.ZodBoolean;
|
|
257
|
+
fileUrl: z.ZodString;
|
|
258
|
+
permalink: z.ZodNullable<z.ZodString>;
|
|
259
|
+
permalinkUrl: z.ZodNullable<z.ZodString>;
|
|
260
|
+
contentVersion: z.ZodString;
|
|
210
261
|
}, z.core.$strip>>;
|
|
211
262
|
nextCursor: z.ZodNullable<z.ZodString>;
|
|
212
263
|
}, z.core.$strip>;
|
|
@@ -234,6 +285,10 @@ export declare const getAssetResponseSchema: z.ZodObject<{
|
|
|
234
285
|
updatedAt: z.ZodString;
|
|
235
286
|
deletedAt: z.ZodNullable<z.ZodString>;
|
|
236
287
|
pendingCleanup: z.ZodBoolean;
|
|
288
|
+
fileUrl: z.ZodString;
|
|
289
|
+
permalink: z.ZodNullable<z.ZodString>;
|
|
290
|
+
permalinkUrl: z.ZodNullable<z.ZodString>;
|
|
291
|
+
contentVersion: z.ZodString;
|
|
237
292
|
altText: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
238
293
|
references: z.ZodArray<z.ZodObject<{
|
|
239
294
|
kind: z.ZodEnum<{
|
|
@@ -252,6 +307,20 @@ export declare const getAssetResponseSchema: z.ZodObject<{
|
|
|
252
307
|
entityId: z.ZodString;
|
|
253
308
|
label: z.ZodString;
|
|
254
309
|
}, z.core.$strip>>;
|
|
310
|
+
previousVersion: z.ZodNullable<z.ZodObject<{
|
|
311
|
+
filename: z.ZodString;
|
|
312
|
+
mimeType: z.ZodString;
|
|
313
|
+
sizeBytes: z.ZodNumber;
|
|
314
|
+
contentVersion: z.ZodString;
|
|
315
|
+
replacedAt: z.ZodString;
|
|
316
|
+
replacedBy: z.ZodNullable<z.ZodObject<{
|
|
317
|
+
id: z.ZodString;
|
|
318
|
+
displayName: z.ZodString;
|
|
319
|
+
}, z.core.$strip>>;
|
|
320
|
+
restorableUntil: z.ZodString;
|
|
321
|
+
}, z.core.$strip>>;
|
|
322
|
+
retentionDays: z.ZodNumber;
|
|
323
|
+
replaceable: z.ZodBoolean;
|
|
255
324
|
}, z.core.$strip>;
|
|
256
325
|
}, z.core.$strip>;
|
|
257
326
|
export type GetAssetResponse = z.infer<typeof getAssetResponseSchema>;
|
|
@@ -288,6 +357,35 @@ export declare const moveManyAssetsResponseSchema: z.ZodObject<{
|
|
|
288
357
|
}, z.core.$strip>;
|
|
289
358
|
}, z.core.$strip>;
|
|
290
359
|
export type MoveManyAssetsResponse = z.infer<typeof moveManyAssetsResponseSchema>;
|
|
360
|
+
export declare const ASSET_PERMALINK_MAX_LENGTH = 200;
|
|
361
|
+
export type AssetPermalinkInvalidReason = 'empty' | 'too_long' | 'invalid_characters' | 'invalid_segment' | 'uuid_shaped';
|
|
362
|
+
/**
|
|
363
|
+
* True for the shape the file route treats as an asset id, in either case. A
|
|
364
|
+
* permalink of this shape would be unreachable, so the validator refuses it.
|
|
365
|
+
*/
|
|
366
|
+
export declare function isAssetIdShaped(segment: string): boolean;
|
|
367
|
+
/**
|
|
368
|
+
* The one permalink rule for the server and the admin form. Pure; no I/O.
|
|
369
|
+
* Checks run in a fixed order so a value breaking several rules always gets
|
|
370
|
+
* the same reason.
|
|
371
|
+
*/
|
|
372
|
+
export declare function validateAssetPermalink(value: string): {
|
|
373
|
+
ok: true;
|
|
374
|
+
} | {
|
|
375
|
+
ok: false;
|
|
376
|
+
reason: AssetPermalinkInvalidReason;
|
|
377
|
+
};
|
|
378
|
+
export declare const setAssetPermalinkRequestSchema: z.ZodObject<{
|
|
379
|
+
permalink: z.ZodString;
|
|
380
|
+
confirmReuse: z.ZodOptional<z.ZodBoolean>;
|
|
381
|
+
}, z.core.$strip>;
|
|
382
|
+
export type SetAssetPermalinkRequest = z.infer<typeof setAssetPermalinkRequestSchema>;
|
|
383
|
+
/** Both required: a restore names the current file and the previous file it brings back. */
|
|
384
|
+
export declare const restorePreviousAssetVersionRequestSchema: z.ZodObject<{
|
|
385
|
+
expectedContentVersion: z.ZodString;
|
|
386
|
+
expectedPreviousContentVersion: z.ZodString;
|
|
387
|
+
}, z.core.$strip>;
|
|
388
|
+
export type RestorePreviousAssetVersionRequest = z.infer<typeof restorePreviousAssetVersionRequestSchema>;
|
|
291
389
|
export declare const storageSelfCheckResponseSchema: z.ZodObject<{
|
|
292
390
|
data: z.ZodObject<{
|
|
293
391
|
adapter: z.ZodEnum<{
|
|
@@ -373,6 +471,10 @@ export interface AssetRecord {
|
|
|
373
471
|
createdAt: Date;
|
|
374
472
|
updatedAt: Date;
|
|
375
473
|
deletedAt: Date | null;
|
|
474
|
+
/** Identity of the bytes the asset currently holds (specs/156-asset-stable-url/). */
|
|
475
|
+
contentVersion: string;
|
|
476
|
+
/** Operator-chosen alias, or null. */
|
|
477
|
+
permalink: string | null;
|
|
376
478
|
}
|
|
377
479
|
/**
|
|
378
480
|
* Container name: `assetReadPort`. Owner: `assets_library`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assets-library.d.ts","sourceRoot":"","sources":["../src/assets-library.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,eAAO,MAAM,qBAAqB;;;EAAgC,CAAC;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;EAA2C,CAAC;AACjF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,uFAAuF;AACvF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;EAYnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;iBAI/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE,eAAO,MAAM,iBAAiB;;;;;;;;iBAQ5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,yBAAyB;;;;;;;;;;iBAEpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,wBAAwB;;;;iBAQjC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,yBAAyB;;;;;;iBAEpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,0BAA0B;;;;;iBAKrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAM9E;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB
|
|
1
|
+
{"version":3,"file":"assets-library.d.ts","sourceRoot":"","sources":["../src/assets-library.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,eAAO,MAAM,qBAAqB;;;EAAgC,CAAC;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;EAA2C,CAAC;AACjF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,uFAAuF;AACvF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;EAYnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;iBAI/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE,eAAO,MAAM,iBAAiB;;;;;;;;iBAQ5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,yBAAyB;;;;;;;;;;iBAEpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,kCAAkC;;;;iBAE7C,CAAC;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE9F,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,wBAAwB;;;;iBAQjC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,yBAAyB;;;;;;iBAEpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,0BAA0B;;;;;iBAKrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAM9E;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsB7B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,sFAAsF;AACtF,eAAO,MAAM,0BAA0B;;;;;;;;;;;iBASrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,wFAAwF;AACxF,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkB5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,qBAAqB;;;;;;;;;;;iBAQhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGnC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAwC,CAAC;AAC5E,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,yBAAyB;;;;;iBAKpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAM5E,eAAO,MAAM,uBAAuB;;;;;;;;;iBAQuD,CAAC;AAC5F,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,sBAAsB;;iBAAgD,CAAC;AACpF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,eAAO,MAAM,4BAA4B;;;;iBAEvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAMlF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,MAAM,MAAM,2BAA2B,GACnC,OAAO,GACP,UAAU,GACV,oBAAoB,GACpB,iBAAiB,GACjB,aAAa,CAAC;AAKlB;;;GAGG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAExD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,GACZ;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,2BAA2B,CAAA;CAAE,CAUnE;AAED,eAAO,MAAM,8BAA8B;;;iBAQzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF,4FAA4F;AAC5F,eAAO,MAAM,wCAAwC;;;iBAGnD,CAAC;AACH,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,wCAAwC,CAChD,CAAC;AAMF,eAAO,MAAM,8BAA8B;;;;;;;;;;iBAMzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;iBAOrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAM9E,eAAO,MAAM,kBAAkB;;;;;;;;iBAMf,CAAC;AACjB,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,wFAAwF;AACxF,eAAO,MAAM,0BAA0B;;;;;;;;;iBAMrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAU9E;;;;;GAKG;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,aAAa,GAAG,OAAO,CAAC;AAElF,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,eAAe,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,cAAc,EAAE,OAAO,GAAG,IAAI,GAAG,KAAK,GAAG,QAAQ,CAAC;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,qFAAqF;IACrF,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IACpF,SAAS,CACP,GAAG,EAAE,SAAS,MAAM,EAAE,EACtB,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAC/B,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,iBAAiB,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;CAC7D;AAED,2EAA2E;AAC3E,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;CAC/D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;IACrD,qFAAqF;IACrF,MAAM,IAAI,SAAS,MAAM,EAAE,CAAC;IAC5B,yEAAyE;IACzE,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC3D;;;;;OAKG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;CAChF;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,gBAAgB;IAC/B,+EAA+E;IAC/E,QAAQ,EAAE,MAAM,CAAC;IACjB,qFAAqF;IACrF,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,yCAAyC;IACzC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChD,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC1E,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;CAC/E;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;CACtE;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;AAE7E,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,eAAe,CAAC;IAC5B,6BAA6B;IAC7B,MAAM,EAAE,iBAAiB,CAAC;IAC1B,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qEAAqE;AACrE,MAAM,WAAW,WAAW;IAC1B,kFAAkF;IAClF,QAAQ,CAAC,IAAI,EAAE,wBAAwB,CAAC;IACxC,GAAG,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3D,MAAM,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,iBAAiB;IAChC,4CAA4C;IAC5C,SAAS,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE"}
|
package/dist/assets-library.js
CHANGED
|
@@ -53,6 +53,14 @@ export const assetFolderSchema = z.object({
|
|
|
53
53
|
export const listFoldersResponseSchema = z.object({
|
|
54
54
|
data: z.array(assetFolderSchema),
|
|
55
55
|
});
|
|
56
|
+
/**
|
|
57
|
+
* `GET /api/v1/admin/assets/folders/:folderId/permalink-count` — how many live
|
|
58
|
+
* assets in the folder's subtree have a permalink, named by the folder delete
|
|
59
|
+
* confirmation (specs/156-asset-stable-url/, owner ruling S4).
|
|
60
|
+
*/
|
|
61
|
+
export const folderPermalinkCountResponseSchema = z.object({
|
|
62
|
+
data: z.object({ permalinkedAssets: z.number().int().nonnegative() }),
|
|
63
|
+
});
|
|
56
64
|
export const createFolderRequestSchema = z.object({
|
|
57
65
|
parentId: uuidSchema.nullable(),
|
|
58
66
|
name: z.string().min(1).max(160),
|
|
@@ -98,11 +106,45 @@ export const assetSummarySchema = z.object({
|
|
|
98
106
|
updatedAt: isoDateTimeSchema,
|
|
99
107
|
deletedAt: isoDateTimeSchema.nullable(),
|
|
100
108
|
pendingCleanup: z.boolean(),
|
|
109
|
+
/** The stable, unversioned file URL — the same across replaces (specs/156-asset-stable-url/). */
|
|
110
|
+
fileUrl: z.string(),
|
|
111
|
+
/** Operator-chosen alias served at `<base>/assets/file/<permalink>`, or null. */
|
|
112
|
+
permalink: z.string().nullable(),
|
|
113
|
+
/** Absolute permalink URL on the local public base, or null when no permalink is set. */
|
|
114
|
+
permalinkUrl: z.string().nullable(),
|
|
115
|
+
/** Identity of the bytes the asset currently holds. */
|
|
116
|
+
contentVersion: z.string(),
|
|
117
|
+
});
|
|
118
|
+
/** The one kept previous version of an asset's file, as the detail panel shows it. */
|
|
119
|
+
export const assetPreviousVersionSchema = z.object({
|
|
120
|
+
filename: z.string().min(1).max(255),
|
|
121
|
+
mimeType: z.string().min(1).max(127),
|
|
122
|
+
sizeBytes: z.number().int().nonnegative(),
|
|
123
|
+
contentVersion: z.string().min(1).max(32),
|
|
124
|
+
replacedAt: isoDateTimeSchema,
|
|
125
|
+
replacedBy: z.object({ id: uuidSchema, displayName: z.string() }).nullable(),
|
|
126
|
+
/** `replacedAt` + `assets.soft_delete_retention_days` as read now. */
|
|
127
|
+
restorableUntil: isoDateTimeSchema,
|
|
101
128
|
});
|
|
102
129
|
/** Detail extends summary with multilingual alt text + the deletion-protection list. */
|
|
103
130
|
export const assetDetailSchema = assetSummarySchema.extend({
|
|
104
131
|
altText: multilingualStringSchema.nullable(),
|
|
105
132
|
references: z.array(assetReferenceSchema),
|
|
133
|
+
/** The one kept previous version of the file, or null (specs/156-asset-stable-url/). */
|
|
134
|
+
previousVersion: assetPreviousVersionSchema.nullable(),
|
|
135
|
+
/**
|
|
136
|
+
* `assets.soft_delete_retention_days` as the retention sweep reads it, in
|
|
137
|
+
* whole days (at least one): how long a replaced file stays restorable, named
|
|
138
|
+
* by the replace confirmation (specs/156-asset-stable-url/).
|
|
139
|
+
*/
|
|
140
|
+
retentionDays: z.number().int().min(1),
|
|
141
|
+
/**
|
|
142
|
+
* Whether the file can be replaced in place (and a previous version
|
|
143
|
+
* restored): false for a legacy row and for a row with no storage key, which
|
|
144
|
+
* both answer `409 ASSET_LEGACY_CANNOT_REPLACE` (specs/156-asset-stable-url/,
|
|
145
|
+
* owner ruling S3).
|
|
146
|
+
*/
|
|
147
|
+
replaceable: z.boolean(),
|
|
106
148
|
});
|
|
107
149
|
export const listAssetsQuerySchema = z.object({
|
|
108
150
|
folderId: uuidSchema.nullable().optional(),
|
|
@@ -145,6 +187,53 @@ export const moveManyAssetsResponseSchema = z.object({
|
|
|
145
187
|
data: z.object({ movedCount: z.number().int().nonnegative() }),
|
|
146
188
|
});
|
|
147
189
|
// ────────────────────────────────────────────────────────────────────────────
|
|
190
|
+
// (2) HTTP — permalinks and the previous version (specs/156-asset-stable-url/)
|
|
191
|
+
// ────────────────────────────────────────────────────────────────────────────
|
|
192
|
+
export const ASSET_PERMALINK_MAX_LENGTH = 200;
|
|
193
|
+
const ASSET_ID_SHAPE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
194
|
+
const PERMALINK_CHARACTERS = /^[A-Za-z0-9._/-]+$/;
|
|
195
|
+
/**
|
|
196
|
+
* True for the shape the file route treats as an asset id, in either case. A
|
|
197
|
+
* permalink of this shape would be unreachable, so the validator refuses it.
|
|
198
|
+
*/
|
|
199
|
+
export function isAssetIdShaped(segment) {
|
|
200
|
+
return ASSET_ID_SHAPE.test(segment);
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* The one permalink rule for the server and the admin form. Pure; no I/O.
|
|
204
|
+
* Checks run in a fixed order so a value breaking several rules always gets
|
|
205
|
+
* the same reason.
|
|
206
|
+
*/
|
|
207
|
+
export function validateAssetPermalink(value) {
|
|
208
|
+
if (value.length === 0)
|
|
209
|
+
return { ok: false, reason: 'empty' };
|
|
210
|
+
if (value.length > ASSET_PERMALINK_MAX_LENGTH)
|
|
211
|
+
return { ok: false, reason: 'too_long' };
|
|
212
|
+
if (!PERMALINK_CHARACTERS.test(value))
|
|
213
|
+
return { ok: false, reason: 'invalid_characters' };
|
|
214
|
+
const segments = value.split('/');
|
|
215
|
+
if (segments.some((segment) => segment === '' || segment === '.' || segment === '..')) {
|
|
216
|
+
return { ok: false, reason: 'invalid_segment' };
|
|
217
|
+
}
|
|
218
|
+
if (isAssetIdShaped(value))
|
|
219
|
+
return { ok: false, reason: 'uuid_shaped' };
|
|
220
|
+
return { ok: true };
|
|
221
|
+
}
|
|
222
|
+
export const setAssetPermalinkRequestSchema = z.object({
|
|
223
|
+
/** Shape judged by `validateAssetPermalink`; the bound only caps the body. */
|
|
224
|
+
permalink: z.string().max(ASSET_PERMALINK_MAX_LENGTH * 2),
|
|
225
|
+
/**
|
|
226
|
+
* Acknowledges taking a permalink whose last holder was a different asset;
|
|
227
|
+
* never needed by the asset that last held it.
|
|
228
|
+
*/
|
|
229
|
+
confirmReuse: z.boolean().optional(),
|
|
230
|
+
});
|
|
231
|
+
/** Both required: a restore names the current file and the previous file it brings back. */
|
|
232
|
+
export const restorePreviousAssetVersionRequestSchema = z.object({
|
|
233
|
+
expectedContentVersion: z.string().min(1).max(32),
|
|
234
|
+
expectedPreviousContentVersion: z.string().min(1).max(32),
|
|
235
|
+
});
|
|
236
|
+
// ────────────────────────────────────────────────────────────────────────────
|
|
148
237
|
// (2) HTTP — storage administration
|
|
149
238
|
// ────────────────────────────────────────────────────────────────────────────
|
|
150
239
|
export const storageSelfCheckResponseSchema = z.object({
|