@strapi/content-manager 0.0.0 → 5.0.0-beta.11

package/dist/admin/src/services/uid.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Related to the InputUID component, not the UIDs of content-types.
+ */
+import { GenerateUID, CheckUIDAvailability } from '../../../shared/contracts/uid';
+declare const useGenerateUIDMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/query").MutationDefinition<{
+    contentTypeUID: string;
+    data: {
+        id: import("@strapi/types/dist/data").ID;
+    } & {
+        [key: string]: any;
+    };
+    field: string;
+} & {
+    params: GenerateUID.Request['query'];
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@strapi/admin/strapi-admin").QueryArguments, unknown, import("@strapi/admin/strapi-admin").BaseQueryError, {}, {}>, "ComponentConfiguration" | "ContentTypesConfiguration" | "ContentTypeSettings" | "Document" | "InitialData" | "HistoryVersion" | "Relations", string, "adminApi">>, useGetDefaultUIDQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<{
+    contentTypeUID: string;
+    data: {
+        id: import("@strapi/types/dist/data").ID;
+    } & {
+        [key: string]: any;
+    };
+    field: string;
+} & {
+    params: GenerateUID.Request['query'];
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@strapi/admin/strapi-admin").QueryArguments, unknown, import("@strapi/admin/strapi-admin").BaseQueryError, {}, {}>, "ComponentConfiguration" | "ContentTypesConfiguration" | "ContentTypeSettings" | "Document" | "InitialData" | "HistoryVersion" | "Relations", string, "adminApi">>, useGetAvailabilityQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<{
+    contentTypeUID: string;
+    field: string;
+    value: string;
+} & {
+    params: CheckUIDAvailability.Request['query'];
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@strapi/admin/strapi-admin").QueryArguments, unknown, import("@strapi/admin/strapi-admin").BaseQueryError, {}, {}>, "ComponentConfiguration" | "ContentTypesConfiguration" | "ContentTypeSettings" | "Document" | "InitialData" | "HistoryVersion" | "Relations", CheckUIDAvailability.Response, "adminApi">>;
+export { useGenerateUIDMutation, useGetDefaultUIDQuery, useGetAvailabilityQuery };

package/dist/admin/src/utils/api.d.ts

@@ -0,0 +1,24 @@
+import { SerializedError } from '@reduxjs/toolkit';
+import { ApiError, type UnknownApiError } from '@strapi/admin/strapi-admin';
+interface Query {
+    plugins?: Record<string, unknown>;
+    _q?: string;
+    [key: string]: any;
+}
+/**
+ * This type extracts the plugin options from the query
+ * and appends them to the root of the query
+ */
+type TransformedQuery<TQuery extends Query> = Omit<TQuery, 'plugins'> & {
+    [key: string]: string;
+};
+/**
+ * @description
+ * Creates a valid query params object for get requests
+ * ie. plugins[18n][locale]=en becomes locale=en
+ */
+declare const buildValidParams: <TQuery extends Query>(query: TQuery) => TransformedQuery<TQuery>;
+type BaseQueryError = ApiError | UnknownApiError;
+declare const isBaseQueryError: (error: BaseQueryError | SerializedError) => error is BaseQueryError;
+export { isBaseQueryError, buildValidParams };
+export type { BaseQueryError, UnknownApiError };

package/dist/admin/src/utils/attributes.d.ts

@@ -0,0 +1,19 @@
+import type { ComponentsDictionary, Schema } from '../hooks/useDocument';
+import type { Schema as SchemaUtils } from '@strapi/types';
+declare const checkIfAttributeIsDisplayable: (attribute: SchemaUtils.Attribute.AnyAttribute) => boolean;
+interface MainField {
+    name: string;
+    type: SchemaUtils.Attribute.Kind | 'custom';
+}
+/**
+ * @internal
+ * @description given an attribute, content-type schemas & component schemas, find the mainField name & type.
+ * If the attribute does not need a `mainField` then we return undefined. If we do not find the type
+ * of the field, we assume it's a string #sensible-defaults
+ */
+declare const getMainField: (attribute: SchemaUtils.Attribute.AnyAttribute, mainFieldName: string | undefined, { schemas, components }: {
+    schemas: Schema[];
+    components: ComponentsDictionary;
+}) => MainField | undefined;
+export { checkIfAttributeIsDisplayable, getMainField };
+export type { MainField };

package/dist/admin/src/utils/objects.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Deeply get a value from an object via its path.
+ */
+export declare function getIn(obj: any, key: string | string[], def?: any, pathStartIndex?: number): any;
+/** @internal is the given object an Object? */
+export declare const isObject: (obj: any) => obj is object;
+/** @internal is the given object an integer? */
+export declare const isInteger: (obj: any) => boolean;
+/**
+ * Deeply set a value from in object via its path. If the value at `path`
+ * has changed, return a shallow copy of obj with `value` set at `path`.
+ * If `value` has not changed, return the original `obj`.
+ *
+ * Existing objects / arrays along `path` are also shallow copied. Sibling
+ * objects along path retain the same internal js reference. Since new
+ * objects / arrays are only created along `path`, we can test if anything
+ * changed in a nested structure by comparing the object's reference in
+ * the old and new object, similar to how russian doll cache invalidation
+ * works.
+ *
+ * In earlier versions of this function, which used cloneDeep, there were
+ * issues whereby settings a nested value would mutate the parent
+ * instead of creating a new object. `clone` avoids that bug making a
+ * shallow copy of the objects along the update path
+ * so no object is mutated in place.
+ *
+ * Before changing this function, please read through the following
+ * discussions.
+ *
+ * @see https://github.com/developit/linkstate
+ * @see https://github.com/jaredpalmer/formik/pull/123
+ */
+export declare function setIn(obj: any, path: string, value: any): any;

package/dist/admin/src/utils/relations.d.ts

@@ -0,0 +1,12 @@
+import type { MainField } from './attributes';
+import type { RelationResult } from '../../../shared/contracts/relations';
+/**
+ * @internal
+ * @description Get the label of a relation, the contract has [key: string]: unknown,
+ * so we need to check if the mainFieldKey is defined and if the relation has a value
+ * under that property. If it does, we then verify it's type of string and return it.
+ *
+ * We fallback to the documentId.
+ */
+declare const getRelationLabel: (relation: RelationResult, mainField?: MainField) => string;
+export { getRelationLabel };

package/dist/admin/src/utils/strings.d.ts

@@ -0,0 +1,2 @@
+declare const capitalise: (str: string) => string;
+export { capitalise };

package/dist/admin/src/utils/translations.d.ts

@@ -0,0 +1,4 @@
+type TradOptions = Record<string, string>;
+declare const prefixPluginTranslations: (trad: TradOptions, pluginId: string) => TradOptions;
+declare const getTranslation: (id: string) => string;
+export { getTranslation, prefixPluginTranslations };

package/dist/admin/src/utils/urls.d.ts

@@ -0,0 +1,2 @@
+declare const prefixFileUrlWithBackendUrl: (fileURL?: string) => string | undefined;
+export { prefixFileUrlWithBackendUrl };

package/dist/admin/src/utils/users.d.ts

@@ -0,0 +1,6 @@
+import type { SanitizedAdminUser } from '@strapi/admin/strapi-admin';
+/**
+ * Retrieves the display name of an admin panel user
+ */
+declare const getDisplayName: ({ firstname, lastname, username, email, }?: Partial<Pick<SanitizedAdminUser, 'firstname' | 'lastname' | 'username' | 'email'>>) => string;
+export { getDisplayName };

package/dist/admin/src/utils/validation.d.ts

@@ -0,0 +1,7 @@
+import * as yup from 'yup';
+import type { ComponentsDictionary, Schema } from '../hooks/useDocument';
+/**
+ * TODO: should we create a Map to store these based on the hash of the schema?
+ */
+declare const createYupSchema: (attributes?: Schema['attributes'], components?: ComponentsDictionary) => yup.ObjectSchema<any>;
+export { createYupSchema };