@strapi/types 5.0.0-beta.2 → 5.0.0-beta.4
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/core/strapi.d.ts +8 -22
- package/dist/core/strapi.d.ts.map +1 -1
- package/dist/data/component.d.ts +9 -0
- package/dist/data/component.d.ts.map +1 -1
- package/dist/data/constants.d.ts +3 -0
- package/dist/data/constants.d.ts.map +1 -1
- package/dist/data/content-type.d.ts +9 -0
- package/dist/data/content-type.d.ts.map +1 -1
- package/dist/data/entity.d.ts +6 -0
- package/dist/data/entity.d.ts.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/modules/documents/component-extension.d.ts +22 -0
- package/dist/modules/documents/component-extension.d.ts.map +1 -0
- package/dist/modules/documents/document-engine.d.ts +0 -1
- package/dist/modules/documents/index.d.ts +2 -1
- package/dist/modules/documents/index.d.ts.map +1 -1
- package/dist/modules/documents/middleware.d.ts +13 -8
- package/dist/modules/documents/middleware.d.ts.map +1 -1
- package/dist/modules/documents/params/document-engine.d.ts +22 -9
- package/dist/modules/documents/params/document-engine.d.ts.map +1 -1
- package/dist/modules/documents/service-instance.d.ts +38 -32
- package/dist/modules/documents/service-instance.d.ts.map +1 -1
- package/dist/public/registries.d.ts +38 -0
- package/dist/public/registries.d.ts.map +1 -1
- package/dist/public/shared.d.ts +53 -0
- package/dist/public/shared.d.ts.map +1 -1
- package/dist/schema/attribute/base.d.ts +43 -4
- package/dist/schema/attribute/base.d.ts.map +1 -1
- package/dist/schema/attribute/common.d.ts +9 -0
- package/dist/schema/attribute/common.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/biginteger.d.ts +3 -0
- package/dist/schema/attribute/definitions/biginteger.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/blocks.d.ts +3 -0
- package/dist/schema/attribute/definitions/blocks.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/boolean.d.ts +3 -0
- package/dist/schema/attribute/definitions/boolean.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/component.d.ts +3 -0
- package/dist/schema/attribute/definitions/component.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/date-time.d.ts +3 -0
- package/dist/schema/attribute/definitions/date-time.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/date.d.ts +3 -0
- package/dist/schema/attribute/definitions/date.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/decimal.d.ts +3 -0
- package/dist/schema/attribute/definitions/decimal.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/dynamic-zone.d.ts +3 -0
- package/dist/schema/attribute/definitions/dynamic-zone.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/email.d.ts +3 -0
- package/dist/schema/attribute/definitions/email.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/enumeration.d.ts +3 -0
- package/dist/schema/attribute/definitions/enumeration.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/float.d.ts +3 -0
- package/dist/schema/attribute/definitions/float.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/integer.d.ts +3 -0
- package/dist/schema/attribute/definitions/integer.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/json.d.ts +3 -0
- package/dist/schema/attribute/definitions/json.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/media.d.ts +3 -0
- package/dist/schema/attribute/definitions/media.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/password.d.ts +3 -0
- package/dist/schema/attribute/definitions/password.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/relation.d.ts +3 -0
- package/dist/schema/attribute/definitions/relation.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/richtext.d.ts +3 -0
- package/dist/schema/attribute/definitions/richtext.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/string.d.ts +6 -0
- package/dist/schema/attribute/definitions/string.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/text.d.ts +3 -0
- package/dist/schema/attribute/definitions/text.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/time.d.ts +3 -0
- package/dist/schema/attribute/definitions/time.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/timestamp.d.ts +3 -0
- package/dist/schema/attribute/definitions/timestamp.d.ts.map +1 -1
- package/dist/schema/attribute/definitions/uid.d.ts +3 -0
- package/dist/schema/attribute/definitions/uid.d.ts.map +1 -1
- package/dist/schema/attribute/options.d.ts +140 -0
- package/dist/schema/attribute/options.d.ts.map +1 -1
- package/dist/schema/attribute/utils.d.ts +41 -0
- package/dist/schema/attribute/utils.d.ts.map +1 -1
- package/dist/schema/index.d.ts +75 -2
- package/dist/schema/index.d.ts.map +1 -1
- package/dist/struct/schema.d.ts +135 -31
- package/dist/struct/schema.d.ts.map +1 -1
- package/dist/uid/index.d.ts +134 -9
- package/dist/uid/index.d.ts.map +1 -1
- package/package.json +14 -12
package/dist/core/strapi.d.ts
CHANGED
|
@@ -13,25 +13,23 @@ export interface Strapi extends Container {
|
|
|
13
13
|
eventHub: Modules.EventHub.EventHub;
|
|
14
14
|
startupLogger: StartupLogger;
|
|
15
15
|
cron: Modules.Cron.CronService;
|
|
16
|
-
|
|
17
|
-
webhookStore?: Modules.WebhookStore.WebhookStore;
|
|
18
|
-
store?: Modules.CoreStore.CoreStore;
|
|
16
|
+
store: Modules.CoreStore.CoreStore;
|
|
19
17
|
/**
|
|
20
18
|
* @deprecated will be removed in the next major
|
|
21
19
|
*/
|
|
22
|
-
entityValidator
|
|
23
|
-
entityService
|
|
20
|
+
entityValidator: Modules.EntityValidator.EntityValidator;
|
|
21
|
+
entityService: Modules.EntityService.EntityService;
|
|
24
22
|
/**
|
|
25
23
|
* @description interact with documents within Strapi, this API is currently in beta and is subject to change in the future
|
|
26
24
|
* @beta
|
|
27
25
|
*/
|
|
28
|
-
documents
|
|
26
|
+
documents: Modules.Documents.Service;
|
|
29
27
|
telemetry: Modules.Metrics.TelemetryService;
|
|
30
28
|
requestContext: Modules.RequestContext.RequestContext;
|
|
31
29
|
customFields: Modules.CustomFields.CustomFields;
|
|
32
30
|
fetch: Modules.Fetch.Fetch;
|
|
33
31
|
dirs: StrapiDirectories;
|
|
34
|
-
admin
|
|
32
|
+
admin: Core.Module;
|
|
35
33
|
isLoaded: boolean;
|
|
36
34
|
db: Database;
|
|
37
35
|
app: any;
|
|
@@ -45,10 +43,10 @@ export interface Strapi extends Container {
|
|
|
45
43
|
name: string;
|
|
46
44
|
[key: string]: any;
|
|
47
45
|
}[];
|
|
48
|
-
get: (feature: string) => {
|
|
46
|
+
get: (feature: string) => string | {
|
|
49
47
|
name: string;
|
|
50
48
|
[key: string]: any;
|
|
51
|
-
};
|
|
49
|
+
} | undefined;
|
|
52
50
|
};
|
|
53
51
|
};
|
|
54
52
|
features: Modules.Features.FeaturesService;
|
|
@@ -75,7 +73,7 @@ export interface Strapi extends Container {
|
|
|
75
73
|
contentAPI: Modules.ContentAPI.ContentApi;
|
|
76
74
|
sanitizers: Modules.Sanitizers.SanitizersRegistry;
|
|
77
75
|
validators: Modules.Validators.ValidatorsRegistry;
|
|
78
|
-
load(): Promise<Strapi
|
|
76
|
+
load(): Promise<Strapi>;
|
|
79
77
|
start(): Promise<Strapi>;
|
|
80
78
|
destroy(): Promise<void>;
|
|
81
79
|
sendStartupTelemetry(): void;
|
|
@@ -86,10 +84,8 @@ export interface Strapi extends Container {
|
|
|
86
84
|
listen(): Promise<void>;
|
|
87
85
|
stopWithError(err: unknown, customMessage?: string): never;
|
|
88
86
|
stop(exitCode?: number): never;
|
|
89
|
-
registerInternalHooks(): void;
|
|
90
87
|
register(): Promise<Strapi>;
|
|
91
88
|
bootstrap(): Promise<Strapi>;
|
|
92
|
-
startWebhooks(): Promise<void>;
|
|
93
89
|
runLifecyclesFunctions(lifecycleName: 'register' | 'bootstrap' | 'destroy'): Promise<void>;
|
|
94
90
|
getModel<TSchemaUID extends UID.Schema>(uid: TSchemaUID): TSchemaUID extends UID.ContentType ? Schema.ContentType<TSchemaUID> : TSchemaUID extends UID.Component ? Schema.Component<TSchemaUID> : never;
|
|
95
91
|
query(uid: UID.Schema): ReturnType<Database['query']>;
|
|
@@ -144,14 +140,4 @@ export interface StrapiDirectories {
|
|
|
144
140
|
config: string;
|
|
145
141
|
};
|
|
146
142
|
}
|
|
147
|
-
export interface StrapiOptions {
|
|
148
|
-
appDir?: string;
|
|
149
|
-
distDir?: string;
|
|
150
|
-
autoReload?: boolean;
|
|
151
|
-
serveAdminPanel?: boolean;
|
|
152
|
-
}
|
|
153
|
-
export interface StrapiConstructor {
|
|
154
|
-
new (options?: StrapiOptions): Strapi;
|
|
155
|
-
}
|
|
156
|
-
export type LoadedStrapi = Required<Strapi>;
|
|
157
143
|
//# sourceMappingURL=strapi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/core/strapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,KAAK,IAAI,MAAM,GAAG,CAAC;AAC/B,OAAO,KAAK,KAAK,OAAO,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,MAAO,SAAQ,SAAS;IACvC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,QAAQ,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpC,aAAa,EAAE,aAAa,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,
|
|
1
|
+
{"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/core/strapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,KAAK,IAAI,MAAM,GAAG,CAAC;AAC/B,OAAO,KAAK,KAAK,OAAO,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,MAAO,SAAQ,SAAS;IACvC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,QAAQ,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpC,aAAa,EAAE,aAAa,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC;IACnC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC;IACzD,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC;IACnD;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACrC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC5C,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IACtD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC;IAChD,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAC3B,IAAI,EAAE,iBAAiB,CAAC;IACxB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,EAAE,EAAE,QAAQ,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,EAAE,EAAE;QACF,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACjC,IAAI,EAAE,OAAO,CAAC;QACd,QAAQ,EAAE;YACR,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;YACxC,IAAI,EAAE,MAAM;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,EAAE,CAAC;YACnD,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,GAAG,SAAS,CAAC;SACrF,CAAC;KACH,CAAC;IACF,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;IAC9B,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACjD,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAClC,WAAW,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,EACjD,IAAI,EAAE,eAAe,GACpB,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACpD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACjD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC;IACzC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAC1C,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAClD,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAClD,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,oBAAoB,IAAI,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,aAAa,EAAE,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC3D,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC/B,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,sBAAsB,CAAC,aAAa,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3F,QAAQ,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,EACpC,GAAG,EAAE,UAAU,GACd,UAAU,SAAS,GAAG,CAAC,WAAW,GACjC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,GAC9B,UAAU,SAAS,GAAG,CAAC,SAAS,GAC9B,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAC5B,KAAK,CAAC;IACZ,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,IAAI,CAAC;CACV;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,IAAI,IAAI,CAAC;IACjB,sBAAsB,IAAI,IAAI,CAAC;IAC/B,wBAAwB,IAAI,IAAI,CAAC;IACjC,iBAAiB,CAAC,EAAE,aAAa,EAAE,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACxE;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzF,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5D;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACvD,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH"}
|
package/dist/data/component.d.ts
CHANGED
|
@@ -2,9 +2,18 @@ import type { ID } from './constants';
|
|
|
2
2
|
import type { Intersect } from '../utils';
|
|
3
3
|
import type { AttributeNames, AttributeValueByName } from '../schema';
|
|
4
4
|
import type * as UID from '../uid';
|
|
5
|
+
/**
|
|
6
|
+
* Represents a component entry.
|
|
7
|
+
*
|
|
8
|
+
* @template TComponentUID - The component schema UID
|
|
9
|
+
* @template TComponentKeys - A union of keys to be returned in the final object. If not specified, defaults to all the keys.
|
|
10
|
+
*/
|
|
5
11
|
export type Component<TComponentUID extends UID.Component = UID.Component, TComponentKeys extends AttributeNames<TComponentUID> = AttributeNames<TComponentUID>> = Intersect<[{
|
|
6
12
|
id: ID;
|
|
7
13
|
}, Pick<AttributeValues<TComponentUID>, TComponentKeys>]>;
|
|
14
|
+
/**
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
8
17
|
type AttributeValues<TComponentUID extends UID.Component = UID.Component> = {
|
|
9
18
|
[TAttributeName in AttributeNames<TComponentUID>]?: AttributeValueByName<TComponentUID, TAttributeName> | null;
|
|
10
19
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../src/data/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,SAAS,CACnB,aAAa,SAAS,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,EACnD,cAAc,SAAS,cAAc,CAAC,aAAa,CAAC,GAAG,cAAc,CAAC,aAAa,CAAC,IAClF,SAAS,CAAC,CAAC;IAAE,EAAE,EAAE,EAAE,CAAA;CAAE,EAAE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;AAElF,KAAK,eAAe,CAAC,aAAa,SAAS,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI;KACzE,cAAc,IAAI,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,oBAAoB,CACtE,aAAa,EACb,cAAc,CACf,GAAG,IAAI;CACT,CAAC"}
|
|
1
|
+
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../src/data/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CACnB,aAAa,SAAS,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,EACnD,cAAc,SAAS,cAAc,CAAC,aAAa,CAAC,GAAG,cAAc,CAAC,aAAa,CAAC,IAClF,SAAS,CAAC,CAAC;IAAE,EAAE,EAAE,EAAE,CAAA;CAAE,EAAE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;AAElF;;GAEG;AACH,KAAK,eAAe,CAAC,aAAa,SAAS,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI;KACzE,cAAc,IAAI,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,oBAAoB,CACtE,aAAa,EACb,cAAc,CACf,GAAG,IAAI;CACT,CAAC"}
|
package/dist/data/constants.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/data/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC"}
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/data/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC"}
|
|
@@ -2,7 +2,16 @@ import type { ID } from './constants';
|
|
|
2
2
|
import type { Intersect } from '../utils';
|
|
3
3
|
import type * as UID from '../uid';
|
|
4
4
|
import type { AttributeNames, AttributeValueByName } from '../schema';
|
|
5
|
+
/**
|
|
6
|
+
* A type used as the identifier for a document.
|
|
7
|
+
*/
|
|
5
8
|
export type DocumentID = string;
|
|
9
|
+
/**
|
|
10
|
+
* Represents a content-type entry.
|
|
11
|
+
*
|
|
12
|
+
* @template TContentTypeUID - The content-type schema UID
|
|
13
|
+
* @template TContentTypeKeys - A union of keys to be returned in the final object. If not specified, defaults to all the keys.
|
|
14
|
+
*/
|
|
6
15
|
export type ContentType<TContentTypeUID extends UID.ContentType = UID.ContentType, TContentTypeKeys extends AttributeNames<TContentTypeUID> = AttributeNames<TContentTypeUID>> = Intersect<[
|
|
7
16
|
{
|
|
8
17
|
id: ID;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"content-type.d.ts","sourceRoot":"","sources":["../../src/data/content-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAEtE,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,MAAM,WAAW,CACrB,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,EACzD,gBAAgB,SAAS,cAAc,CAAC,eAAe,CAAC,GAAG,cAAc,CAAC,eAAe,CAAC,IACxF,SAAS,CACX;IAAC;QAAE,EAAE,EAAE,EAAE,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE;IAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,gBAAgB,CAAC;CAAC,CAC/F,CAAC;AAEF,KAAK,eAAe,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;KAC/E,cAAc,IAAI,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,oBAAoB,CACxE,eAAe,EACf,cAAc,CACf,GAAG,IAAI;CACT,CAAC"}
|
|
1
|
+
{"version":3,"file":"content-type.d.ts","sourceRoot":"","sources":["../../src/data/content-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACrB,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,EACzD,gBAAgB,SAAS,cAAc,CAAC,eAAe,CAAC,GAAG,cAAc,CAAC,eAAe,CAAC,IACxF,SAAS,CACX;IAAC;QAAE,EAAE,EAAE,EAAE,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE;IAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,gBAAgB,CAAC;CAAC,CAC/F,CAAC;AAEF,KAAK,eAAe,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;KAC/E,cAAc,IAAI,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,oBAAoB,CACxE,eAAe,EACf,cAAc,CACf,GAAG,IAAI;CACT,CAAC"}
|
package/dist/data/entity.d.ts
CHANGED
|
@@ -2,6 +2,12 @@ import type { ContentType } from './content-type';
|
|
|
2
2
|
import type { Component } from './component';
|
|
3
3
|
import type * as UID from '../uid';
|
|
4
4
|
import type { ModelType, AttributeNames } from '../schema';
|
|
5
|
+
/**
|
|
6
|
+
* Represents any entry, either for a content-type or a component.
|
|
7
|
+
*
|
|
8
|
+
* @template TSchemaUID - The entry schema UID
|
|
9
|
+
* @template TKeys - A union of keys to be returned in the final object. If not specified, defaults to all the keys.
|
|
10
|
+
*/
|
|
5
11
|
export type Entity<TSchemaUID extends UID.Schema = UID.Schema, TKeys extends AttributeNames<TSchemaUID> = AttributeNames<TSchemaUID>> = {
|
|
6
12
|
contentType: ContentType<Extract<TSchemaUID, UID.ContentType>, TKeys>;
|
|
7
13
|
component: Component<Extract<TSchemaUID, UID.Component>, TKeys>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/data/entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3D,MAAM,MAAM,MAAM,CAChB,UAAU,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,EAC1C,KAAK,SAAS,cAAc,CAAC,UAAU,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,IACnE;IACF,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;IACtE,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;CACjE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/data/entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAChB,UAAU,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,EAC1C,KAAK,SAAS,cAAc,CAAC,UAAU,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,IACnE;IACF,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;IACtE,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;CACjE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { Strapi } from './core';
|
|
2
2
|
export type * as Core from './core';
|
|
3
3
|
export type * as Data from './data';
|
|
4
4
|
export type * as Internal from './internal';
|
|
@@ -10,10 +10,10 @@ export type * as Utils from './utils';
|
|
|
10
10
|
export type * as Struct from './struct';
|
|
11
11
|
export type * as UID from './uid';
|
|
12
12
|
declare global {
|
|
13
|
-
var strapi:
|
|
13
|
+
var strapi: Strapi;
|
|
14
14
|
namespace NodeJS {
|
|
15
15
|
interface Global {
|
|
16
|
-
strapi:
|
|
16
|
+
strapi: Strapi;
|
|
17
17
|
}
|
|
18
18
|
}
|
|
19
19
|
}
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,YAAY,KAAK,IAAI,MAAM,QAAQ,CAAC;AACpC,YAAY,KAAK,IAAI,MAAM,QAAQ,CAAC;AACpC,YAAY,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,YAAY,KAAK,OAAO,MAAM,WAAW,CAAC;AAC1C,YAAY,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,YAAY,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,YAAY,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,YAAY,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,YAAY,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,YAAY,KAAK,GAAG,MAAM,OAAO,CAAC;AAElC,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,MAAM,EAAE,MAAM,CAAC;IAGnB,UAAU,MAAM,CAAC;QACf,UAAU,MAAM;YACd,MAAM,EAAE,MAAM,CAAC;SAChB;KACF;CACF"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { UID, Schema } from '../..';
|
|
2
|
+
import type * as EntityService from '../entity-service';
|
|
3
|
+
import type * as AttributeUtils from './params/attributes';
|
|
4
|
+
type ComponentBody = {
|
|
5
|
+
[key: string]: AttributeUtils.GetValue<Schema.Attribute.Component<UID.Component, false> | Schema.Attribute.Component<UID.Component, true> | Schema.Attribute.DynamicZone>;
|
|
6
|
+
};
|
|
7
|
+
export type ComponentExtension = {
|
|
8
|
+
/**
|
|
9
|
+
* @internal
|
|
10
|
+
* Exposed for use within document service middlewares
|
|
11
|
+
*/
|
|
12
|
+
updateComponents: (entityToUpdate: {
|
|
13
|
+
id: EntityService.Params.Attribute.ID;
|
|
14
|
+
}, data: EntityService.Params.Data.Input<UID.Schema>) => Promise<ComponentBody>;
|
|
15
|
+
/**
|
|
16
|
+
* @internal
|
|
17
|
+
* Exposed for use within document service middlewares
|
|
18
|
+
*/
|
|
19
|
+
omitComponentData: (data: EntityService.Params.Data.Input<Schema.ContentType['uid']>) => Partial<EntityService.Params.Data.Input<Schema.ContentType['uid']>>;
|
|
20
|
+
};
|
|
21
|
+
export {};
|
|
22
|
+
//# sourceMappingURL=component-extension.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"component-extension.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/component-extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,KAAK,KAAK,aAAa,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAC;AAG3D,KAAK,aAAa,GAAG;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,QAAQ,CAClC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,GAChD,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAC/C,MAAM,CAAC,SAAS,CAAC,WAAW,CAC/B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,gBAAgB,EAAE,CAChB,cAAc,EAAE;QACd,EAAE,EAAE,aAAa,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;KACvC,EACD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAC9C,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5B;;;OAGG;IACH,iBAAiB,EAAE,CACjB,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,KAC7D,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CAC1E,CAAC"}
|
|
@@ -2,6 +2,7 @@ import type { UID } from '../..';
|
|
|
2
2
|
import type * as Middleware from './middleware';
|
|
3
3
|
import type { ServiceInstance } from './service-instance';
|
|
4
4
|
import type { AnyDocument } from './result';
|
|
5
|
+
import type { ComponentExtension } from './component-extension';
|
|
5
6
|
export * as Middleware from './middleware';
|
|
6
7
|
export * as Params from './params';
|
|
7
8
|
export * from './plugin';
|
|
@@ -12,7 +13,7 @@ type ServiceUtils = {
|
|
|
12
13
|
transformData: (data: any, opts: any) => Promise<AnyDocument>;
|
|
13
14
|
};
|
|
14
15
|
export type Service = {
|
|
15
|
-
<TContentTypeUID extends UID.ContentType>(uid: TContentTypeUID): ServiceInstance<TContentTypeUID
|
|
16
|
+
<TContentTypeUID extends UID.ContentType>(uid: TContentTypeUID): ServiceInstance<TContentTypeUID> & ComponentExtension;
|
|
16
17
|
utils: ServiceUtils;
|
|
17
18
|
/** Add a middleware for all uid's and a specific action
|
|
18
19
|
* @example - Add a default locale
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AAEnC,MAAM,MAAM,EAAE,GAAG,MAAM,CAAC;AAExB,KAAK,YAAY,GAAG;IAClB,aAAa,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,EACtC,GAAG,EAAE,eAAe,GACnB,eAAe,CAAC,eAAe,CAAC,GAAG,kBAAkB,CAAC;IACzD,KAAK,EAAE,YAAY,CAAC;IACpB;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,UAAU,KAAK,OAAO,CAAC;CAC7C,CAAC"}
|
|
@@ -1,9 +1,14 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import type { ServiceInstance } from './service-instance';
|
|
3
|
-
export
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import type { Schema, UID } from '../..';
|
|
2
|
+
import type { ServiceInstance, ServiceParams } from './service-instance';
|
|
3
|
+
export type Context<TUID extends UID.ContentType = UID.ContentType> = {
|
|
4
|
+
[TUIDKey in TUID]: {
|
|
5
|
+
[TKey in keyof ServiceParams<TUIDKey>]: {
|
|
6
|
+
contentType: Schema.ContentType<TUIDKey>;
|
|
7
|
+
uid: TUIDKey;
|
|
8
|
+
action: TKey;
|
|
9
|
+
params: ServiceParams<TUIDKey>[TKey];
|
|
10
|
+
};
|
|
11
|
+
}[keyof ServiceParams<TUIDKey>];
|
|
12
|
+
}[TUID];
|
|
13
|
+
export type Middleware = (ctx: Context, next: () => ReturnType<ServiceInstance[keyof ServiceInstance]>) => ReturnType<ServiceInstance[keyof ServiceInstance]> extends Promise<infer Return> ? Promise<Return> : Promise<ReturnType<ServiceInstance[keyof ServiceInstance]>>;
|
|
9
14
|
//# sourceMappingURL=middleware.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/middleware.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/middleware.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEzE,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;KACnE,OAAO,IAAI,IAAI,GAAG;SAChB,IAAI,IAAI,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG;YACtC,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACzC,GAAG,EAAE,OAAO,CAAC;YACb,MAAM,EAAE,IAAI,CAAC;YACb,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;SACtC;KACF,CAAC,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;CAChC,CAAC,IAAI,CAAC,CAAC;AAER,MAAM,MAAM,UAAU,GAAG,CACvB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,UAAU,CAAC,eAAe,CAAC,MAAM,eAAe,CAAC,CAAC,KAC3D,UAAU,CAAC,eAAe,CAAC,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,MAAM,CAAC,GACjF,OAAO,CAAC,MAAM,CAAC,GACf,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,eAAe,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -1,19 +1,32 @@
|
|
|
1
1
|
import type * as UID from '../../../uid';
|
|
2
2
|
import { Pick } from '.';
|
|
3
|
+
import { ID } from '..';
|
|
3
4
|
/**
|
|
4
5
|
* Document Service specific method params
|
|
5
6
|
*/
|
|
6
7
|
export type FindMany<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'filters' | '_q' | 'pagination' | 'sort' | 'populate' | 'status' | 'locale' | 'plugin' | 'lookup'>;
|
|
7
8
|
export type Count<TContentTypeUID extends UID.ContentType> = FindMany<TContentTypeUID>;
|
|
8
9
|
export type FindFirst<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'filters' | '_q' | 'sort' | 'populate' | 'status' | 'locale' | 'plugin' | 'lookup'>;
|
|
9
|
-
export type FindOne<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'populate' | 'filters' | 'status' | 'locale' | 'sort' | 'lookup'
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
export type FindOne<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'populate' | 'filters' | 'status' | 'locale' | 'sort' | 'lookup'> & {
|
|
11
|
+
documentId: ID;
|
|
12
|
+
};
|
|
13
|
+
export type Delete<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'populate' | 'filters' | 'status' | 'locale' | 'lookup'> & {
|
|
14
|
+
documentId: ID;
|
|
15
|
+
};
|
|
12
16
|
export type Create<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data' | 'fields' | 'populate' | 'locale' | 'lookup' | 'status'>;
|
|
13
|
-
export type Clone<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data' | 'fields' | 'populate' | 'status' | 'locale' | 'lookup'
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
export type
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
export type Clone<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data' | 'fields' | 'populate' | 'status' | 'locale' | 'lookup'> & {
|
|
18
|
+
documentId: ID;
|
|
19
|
+
};
|
|
20
|
+
export type Update<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data:partial' | 'fields' | 'populate' | 'locale' | 'lookup'> & {
|
|
21
|
+
documentId: ID;
|
|
22
|
+
};
|
|
23
|
+
export type Publish<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'filters' | 'locale' | 'lookup'> & {
|
|
24
|
+
documentId: ID;
|
|
25
|
+
};
|
|
26
|
+
export type Unpublish<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'filters' | 'locale' | 'lookup'> & {
|
|
27
|
+
documentId: ID;
|
|
28
|
+
};
|
|
29
|
+
export type DiscardDraft<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'filters' | 'locale' | 'lookup'> & {
|
|
30
|
+
documentId: ID;
|
|
31
|
+
};
|
|
19
32
|
//# sourceMappingURL=document-engine.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"document-engine.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/document-engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"document-engine.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/document-engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,IAAI,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAClE,eAAe,EACb,QAAQ,GACR,SAAS,GACT,IAAI,GACJ,YAAY,GACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,CACX,CAAC;AAEF,MAAM,MAAM,KAAK,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,QAAQ,CAAC,eAAe,CAAC,CAAC;AAEvF,MAAM,MAAM,SAAS,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACnE,eAAe,EACf,QAAQ,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAC9F,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACjE,eAAe,EACf,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAC5E,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAChE,eAAe,EACf,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CACnE,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAChE,eAAe,EACf,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAChE,CAAC;AAEF,MAAM,MAAM,KAAK,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAC/D,eAAe,EACf,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAChE,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAChE,eAAe,EACf,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAC7D,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACjE,eAAe,EACf,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAChC,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACnE,eAAe,EACf,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAChC,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACtE,eAAe,EACf,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAChC,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC"}
|
|
@@ -1,42 +1,48 @@
|
|
|
1
|
-
import type { Utils
|
|
2
|
-
import type * as EntityService from '../entity-service';
|
|
3
|
-
import type * as AttributeUtils from './params/attributes';
|
|
1
|
+
import type { Utils } from '../..';
|
|
4
2
|
import type * as UID from '../../uid';
|
|
5
|
-
import type { ID } from '.';
|
|
6
3
|
import type { IsDraftAndPublishEnabled } from './draft-and-publish';
|
|
7
4
|
import type * as Params from './params/document-engine';
|
|
8
5
|
import type * as Result from './result/document-engine';
|
|
9
|
-
type
|
|
10
|
-
|
|
6
|
+
export type ServiceParams<TContentTypeUID extends UID.ContentType = UID.ContentType> = {
|
|
7
|
+
findMany: Params.FindMany<TContentTypeUID>;
|
|
8
|
+
findFirst: Params.FindFirst<TContentTypeUID>;
|
|
9
|
+
findOne: Params.FindOne<TContentTypeUID>;
|
|
10
|
+
delete: Params.Delete<TContentTypeUID>;
|
|
11
|
+
create: Params.Create<TContentTypeUID>;
|
|
12
|
+
clone: Params.Clone<TContentTypeUID>;
|
|
13
|
+
update: Params.Update<TContentTypeUID>;
|
|
14
|
+
count: Params.Count<TContentTypeUID>;
|
|
15
|
+
publish: Params.Publish<TContentTypeUID>;
|
|
16
|
+
unpublish: Params.Unpublish<TContentTypeUID>;
|
|
17
|
+
discardDraft: Params.DiscardDraft<TContentTypeUID>;
|
|
11
18
|
};
|
|
12
|
-
export type
|
|
13
|
-
findMany:
|
|
14
|
-
findFirst:
|
|
15
|
-
findOne:
|
|
16
|
-
delete:
|
|
17
|
-
create:
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
*/
|
|
32
|
-
updateComponents: (uid: UID.Schema, entityToUpdate: {
|
|
33
|
-
id: EntityService.Params.Attribute.ID;
|
|
34
|
-
}, data: EntityService.Params.Data.Input<UID.Schema>) => Promise<ComponentBody>;
|
|
19
|
+
export type ServiceResults<TContentTypeUID extends UID.ContentType = UID.ContentType> = {
|
|
20
|
+
findMany: Result.FindMany<TContentTypeUID, Params.FindMany<TContentTypeUID>>;
|
|
21
|
+
findFirst: Result.FindFirst<TContentTypeUID, Params.FindFirst<TContentTypeUID>>;
|
|
22
|
+
findOne: Result.FindOne<TContentTypeUID, Params.FindOne<TContentTypeUID>>;
|
|
23
|
+
delete: Result.Delete;
|
|
24
|
+
create: Result.Create<TContentTypeUID, Params.Create<TContentTypeUID>>;
|
|
25
|
+
clone: Result.Clone<TContentTypeUID, Params.Clone<TContentTypeUID>>;
|
|
26
|
+
update: Result.Update<TContentTypeUID, Params.Update<TContentTypeUID>>;
|
|
27
|
+
count: Result.Count;
|
|
28
|
+
publish: Result.Publish<TContentTypeUID, Params.Publish<TContentTypeUID>>;
|
|
29
|
+
unpublish: Result.Unpublish<TContentTypeUID, Params.Unpublish<TContentTypeUID>>;
|
|
30
|
+
discardDraft: Result.DiscardDraft<TContentTypeUID, Params.DiscardDraft<TContentTypeUID>>;
|
|
31
|
+
};
|
|
32
|
+
export type ServiceInstance<TContentTypeUID extends UID.ContentType = UID.ContentType, TServiceParams extends ServiceParams<TContentTypeUID> = ServiceParams<TContentTypeUID>, TServiceResults extends ServiceResults<TContentTypeUID> = ServiceResults<TContentTypeUID>> = {
|
|
33
|
+
findMany: (params?: TServiceParams['findMany']) => TServiceResults['findMany'];
|
|
34
|
+
findFirst: (params?: TServiceParams['findFirst']) => TServiceResults['findFirst'];
|
|
35
|
+
findOne: (params: TServiceParams['findOne']) => TServiceResults['findOne'];
|
|
36
|
+
delete: (params: TServiceParams['delete']) => TServiceResults['delete'];
|
|
37
|
+
create: (params: TServiceParams['create']) => TServiceResults['create'];
|
|
35
38
|
/**
|
|
36
39
|
* @internal
|
|
37
|
-
* Exposed for use within document service middlewares
|
|
38
40
|
*/
|
|
39
|
-
|
|
41
|
+
clone: (params: TServiceParams['clone']) => TServiceResults['clone'];
|
|
42
|
+
update: (params: TServiceParams['update']) => TServiceResults['update'];
|
|
43
|
+
count: (params?: TServiceParams['count']) => TServiceResults['count'];
|
|
44
|
+
publish: Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, (params: TServiceParams['publish']) => TServiceResults['publish'], never>;
|
|
45
|
+
unpublish: Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, (params: TServiceParams['unpublish']) => TServiceResults['unpublish'], never>;
|
|
46
|
+
discardDraft: Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, (params: TServiceParams['discardDraft']) => TServiceResults['discardDraft'], never>;
|
|
40
47
|
};
|
|
41
|
-
export {};
|
|
42
48
|
//# sourceMappingURL=service-instance.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service-instance.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/service-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"service-instance.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/service-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,KAAK,KAAK,GAAG,MAAM,WAAW,CAAC;AAEtC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,KAAK,MAAM,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAExD,MAAM,MAAM,aAAa,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;IACrF,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC7C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACzC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC7C,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;IACtF,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7E,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IAChF,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1E,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IACpE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1E,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IAChF,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;CAC1F,CAAC;AAEF,MAAM,MAAM,eAAe,CACzB,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,EACzD,cAAc,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC,eAAe,CAAC,EACtF,eAAe,SAAS,cAAc,CAAC,eAAe,CAAC,GAAG,cAAc,CAAC,eAAe,CAAC,IACvF;IACF,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,KAAK,eAAe,CAAC,UAAU,CAAC,CAAC;IAC/E,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC,KAAK,eAAe,CAAC,WAAW,CAAC,CAAC;IAClF,OAAO,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC,KAAK,eAAe,CAAC,SAAS,CAAC,CAAC;IAC3E,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC;IACxE,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC;IAExE;;OAEG;IACH,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC;IACxE,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC;IAGtE,OAAO,EAAE,KAAK,CAAC,EAAE,CAEf,wBAAwB,CAAC,eAAe,CAAC,EAEzC,CAAC,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC,KAAK,eAAe,CAAC,SAAS,CAAC,EAEjE,KAAK,CACN,CAAC;IAEF,SAAS,EAAE,KAAK,CAAC,EAAE,CACjB,wBAAwB,CAAC,eAAe,CAAC,EACzC,CAAC,MAAM,EAAE,cAAc,CAAC,WAAW,CAAC,KAAK,eAAe,CAAC,WAAW,CAAC,EACrE,KAAK,CACN,CAAC;IAEF,YAAY,EAAE,KAAK,CAAC,EAAE,CACpB,wBAAwB,CAAC,eAAe,CAAC,EACzC,CAAC,MAAM,EAAE,cAAc,CAAC,cAAc,CAAC,KAAK,eAAe,CAAC,cAAc,CAAC,EAC3E,KAAK,CACN,CAAC;CACH,CAAC"}
|
|
@@ -1,9 +1,47 @@
|
|
|
1
1
|
import type { Service, Controller, Policy, Middleware } from '../core';
|
|
2
2
|
import type { UID } from '../internal';
|
|
3
3
|
import type { ComponentSchema, ContentTypeSchema } from '../struct';
|
|
4
|
+
/**
|
|
5
|
+
* Aggregates and interfaces the schemas of various content types under unique identifiers.
|
|
6
|
+
*
|
|
7
|
+
* It allows mapping between unique identifiers of content types and their respective schemas.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* Example usage of ContentTypeSchemas:
|
|
11
|
+
* ```ts
|
|
12
|
+
* declare module '@strapi/types' {
|
|
13
|
+
* export module Public {
|
|
14
|
+
* export module Registries {
|
|
15
|
+
* export interface ContentTypesSchemas {
|
|
16
|
+
* 'api::foo.foo': { ... }
|
|
17
|
+
* }
|
|
18
|
+
* }
|
|
19
|
+
* }
|
|
20
|
+
* }
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
4
23
|
export interface ContentTypeSchemas {
|
|
5
24
|
[TKey: UID.ContentType]: ContentTypeSchema;
|
|
6
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* Aggregates and interfaces the schemas of various components under unique identifiers.
|
|
28
|
+
*
|
|
29
|
+
* It allows mapping between unique identifiers of components and their respective schemas.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* Example usage of ComponentSchemas:
|
|
33
|
+
* ```ts
|
|
34
|
+
* declare module '@strapi/types' {
|
|
35
|
+
* export module Public {
|
|
36
|
+
* export module Registries {
|
|
37
|
+
* export interface ComponentSchemas {
|
|
38
|
+
* 'default.foo': { ... }
|
|
39
|
+
* }
|
|
40
|
+
* }
|
|
41
|
+
* }
|
|
42
|
+
* }
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
7
45
|
export interface ComponentSchemas {
|
|
8
46
|
[TKey: UID.Component]: ComponentSchema;
|
|
9
47
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registries.d.ts","sourceRoot":"","sources":["../../src/public/registries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACvE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEpE,MAAM,WAAW,kBAAkB;IACjC,CAAC,IAAI,EAAE,GAAG,CAAC,WAAW,GAAG,iBAAiB,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,IAAI,EAAE,GAAG,CAAC,SAAS,GAAG,eAAe,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;CACnC"}
|
|
1
|
+
{"version":3,"file":"registries.d.ts","sourceRoot":"","sources":["../../src/public/registries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACvE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEpE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,kBAAkB;IACjC,CAAC,IAAI,EAAE,GAAG,CAAC,WAAW,GAAG,iBAAiB,CAAC;CAC5C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,IAAI,EAAE,GAAG,CAAC,SAAS,GAAG,eAAe,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;CACnC"}
|
package/dist/public/shared.d.ts
CHANGED
|
@@ -1,7 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `DocumentServicePluginParams` interface represents the various document-service's plugin parameters where the key is the parameter, and the value is the related type.
|
|
3
|
+
*
|
|
4
|
+
* Simply put: it enables the definition of document-service parameters from external plugins.
|
|
5
|
+
*
|
|
6
|
+
* For instance, consider each plugin requires various parameters for their execution, this interface can act as a contract to satisfy this requirement.
|
|
7
|
+
*
|
|
8
|
+
* Note: Currently, the `DocumentServicePluginParams` doesn't have any methods or properties, it's an empty interface. This stands as a placeholder which can be extended or implemented by the plugins as required.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* Here's how `DocumentServicePluginParams` can be used to define parameters for a fictional plugin "Internationalization":
|
|
12
|
+
* ```typescript
|
|
13
|
+
* declare module '@strapi/types' {
|
|
14
|
+
* export module Shared {
|
|
15
|
+
* export interface DocumentServicePluginParams {
|
|
16
|
+
* 'locale': string;
|
|
17
|
+
* }
|
|
18
|
+
* }
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @remark This type needs to be reviewed since it's not augmented anywhere yet
|
|
23
|
+
*/
|
|
1
24
|
export interface DocumentServicePluginParams {
|
|
2
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* The `EntityServicePluginParams` interface represents the various entity-service's plugin parameters where the key is the parameter, and the value is the related type.
|
|
28
|
+
*
|
|
29
|
+
* Simply put: it enables the definition of entity-service parameters from external plugins.
|
|
30
|
+
*
|
|
31
|
+
* For instance, consider each plugin requires various parameters for their execution, this interface can act as a contract to satisfy this requirement.
|
|
32
|
+
*
|
|
33
|
+
* Note: Currently, the `EntityServicePluginParams` doesn't have any methods or properties, it's an empty interface. This stands as a placeholder which can be extended or implemented by the plugins as required.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* Here's how `EntityServicePluginParams` can be used to define parameters for a fictional plugin "Internationalization":
|
|
37
|
+
* ```typescript
|
|
38
|
+
* declare module '@strapi/types' {
|
|
39
|
+
* export module Shared {
|
|
40
|
+
* export interface EntityServicePluginParams {
|
|
41
|
+
* 'locale': string;
|
|
42
|
+
* }
|
|
43
|
+
* }
|
|
44
|
+
* }
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @remark This type needs to be reviewed since it's not augmented anywhere yet
|
|
48
|
+
*
|
|
49
|
+
* @deprecated The entity service is deprecated and will be removed in v6. Use the document service instead.
|
|
50
|
+
*/
|
|
3
51
|
export interface EntityServicePluginParams {
|
|
4
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* @remark This type needs to be reviewed since it's not augmented anywhere yet
|
|
55
|
+
*
|
|
56
|
+
* @deprecated
|
|
57
|
+
*/
|
|
5
58
|
export interface PluginActivation {
|
|
6
59
|
[key: keyof any]: unknown;
|
|
7
60
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/public/shared.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,2BAA2B;CAAG;AAE/C,MAAM,WAAW,yBAAyB;CAAG;AAE7C,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,OAAO,CAAC;CAC3B"}
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/public/shared.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,2BAA2B;CAAG;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,yBAAyB;CAAG;AAE7C;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,OAAO,CAAC;CAC3B"}
|