@strapi/strapi 4.14.0-beta.0 → 4.15.0-alpha.0

package/lib/types/core/schemas/index.d.ts

@@ -1,133 +0,0 @@
-import type { Attribute, Utils, Common } from '@strapi/strapi';
-
-/**
- * Literal union type representing the possible natures of a content type
- */
-export type ContentTypeKind = 'singleType' | 'collectionType';
-
-/**
- * Literal union type representing the possible types of a model
- */
-export type ModelType = 'contentType' | 'component';
-
-/**
- * Data structure that can either represent a content type or a component
- */
-export interface Schema {
-  /**
-   * The type of the model. Useful to discriminate content-types from component
-   */
-  modelType: ModelType;
-
-  /**
-   * Informations about schema naming and display
-   */
-  info: Info;
-
-  /**
-   * Map of all the attributes with their name and definition
-   */
-  attributes: Attributes;
-
-  /**
-   * Options declared and read by the plugins
-   */
-  pluginOptions?: PluginOptions;
-
-  /**
-   * Options object dedicated to Strapi core features
-   */
-  options?: Options;
-
-  /**
-   * Custom table name for the schema
-   */
-  collectionName?: string;
-}
-
-/**
- * Data structure containing naming and display information for a Schema
- */
-export interface Info {
-  /**
-   * Default name to use in the admin panel
-   */
-  displayName: string;
-
-  /**
-   * Singular form of the content type name
-   */
-  singularName?: string;
-
-  /**
-   * Plural form of the collection type name
-   */
-  pluralName?: string;
-
-  /**
-   * Description of the model
-   */
-  description?: string;
-
-  /**
-   * FontAwesome (v5) icon name to use for the component's icon in the admin panel
-   */
-  icon?: string;
-}
-
-/**
- * Low level data structure referencing every schema attribute and its name
- */
-export interface Attributes {
-  [key: string]: Attribute.Any;
-}
-
-/**
- * Structure containing every core schema options and their associated value
- */
-export interface Options {
-  draftAndPublish?: boolean;
-  populateCreatorFields?: boolean;
-  comment?: string;
-  version?: string;
-}
-
-export interface PluginOptions {}
-
-/**
- * Schema for a content type
- */
-export interface ContentType extends Schema {
-  modelType: 'contentType';
-
-  /**
-   * Unique identifier of the schema
-   */
-  uid: Common.UID.ContentType;
-
-  /**
-   * Determine the type of the content type (single-type or collection-type)
-   */
-  kind: ContentTypeKind;
-}
-
-/**
- * Schema for a collection type
- */
-export interface CollectionType extends ContentType {
-  kind: 'collectionType';
-}
-
-/**
- * Schema for a single type
- */
-export interface SingleType extends ContentType {
-  kind: 'singleType';
-}
-
-/**
- * Schema for a component
- */
-export interface Component extends Schema {
-  modelType: 'component';
-}

package/lib/types/core/strapi/index.d.ts

@@ -1,453 +0,0 @@
-import type { Database } from '@strapi/database';
-import type { Common, EntityService, Shared } from '@strapi/strapi';
-
-// TODO move custom fields types to a separate file
-interface CustomFieldServerOptions {
-  /**
-   * The name of the custom field
-   */
-  name: string;
-
-  /**
-   * The name of the plugin creating the custom field
-   */
-  pluginId?: string;
-
-  /**
-   * The existing Strapi data type the custom field uses
-   */
-  type: string;
-
-  /**
-   * Settings for the input size in the Admin UI
-   */
-  inputSize?: {
-    default: 4 | 6 | 8 | 12;
-    isResizable: boolean;
-  };
-}
-
-interface CustomFields {
-  register: (customFields: CustomFieldServerOptions[] | CustomFieldServerOptions) => void;
-}
-
-/**
- * The Strapi interface implemented by the main Strapi class.
- */
-export interface Strapi {
-  /**
-   * Getter for the Strapi enterprise edition configuration
-   */
-  readonly EE: any;
-
-  /**
-   * Getter for the Strapi configuration container
-   */
-  readonly config: any;
-
-  /**
-   * Getter for the Strapi admin container
-   */
-  readonly admin: any;
-
-  /**
-   * Getter for the Strapi auth container
-   */
-  readonly auth: any;
-
-  /**
-   * Getter for the Strapi content API container
-   */
-  readonly contentAPI: any;
-
-  /**
-   * Getter for the Strapi sanitizers container
-   */
-  readonly sanitizers: any;
-
-  /**
-   * Getter for the Strapi validators container
-   */
-  readonly validators: any;
-
-  /**
-   * Getter for the Strapi services container
-   *
-   * It returns all the registered services
-   */
-  readonly services: Shared.Services;
-
-  /**
-   * Find a service using its unique identifier
-   */
-  service<TService extends Common.Service = Common.Service>(uid: string): TService | undefined;
-
-  /**
-   * Getter for the Strapi controllers container
-   *
-   * It returns all the registered controllers
-   */
-  readonly controllers: Shared.Controllers;
-
-  /**
-   * Find a controller using its unique identifier
-   */
-  controller<TContentTypeUID extends Common.UID.Controller>(
-    uid: TContentTypeUID
-  ): Shared.Controllers[TContentTypeUID];
-
-  /**
-   * Getter for the Strapi content types container
-   *
-   * It returns all the registered content types
-   */
-  readonly contentTypes: any;
-
-  /**
-   * Find a content type using its unique identifier
-   */
-  contentType(uid: string): any;
-
-  /**
-   * Getter for the Strapi component container
-   *
-   * It returns all the registered components
-   */
-  readonly components: any;
-
-  /**
-   * The custom fields registry
-   *
-   * It returns the custom fields interface
-   */
-  readonly customFields: CustomFields;
-
-  /**
-   * Getter for the Strapi policies container
-   *
-   * It returns all the registered policies
-   */
-  readonly policies: any;
-
-  /**
-   * Find a policy using its name
-   */
-  policy(name: string): any;
-
-  /**
-   * Getter for the Strapi middlewares container
-   *
-   * It returns all the registered middlewares
-   */
-  readonly middlewares: any;
-
-  /**
-   * Find a middleware using its name
-   */
-  middleware(): any;
-
-  /**
-   * Getter for the Strapi plugins container
-   *
-   * It returns all the registered plugins
-   */
-  readonly plugins: any;
-
-  /**
-   * Find a plugin using its name
-   */
-  plugin(name: string): any;
-
-  /**
-   * Getter for the Strapi hooks container
-   *
-   * It returns all the registered hooks
-   */
-  readonly hooks: any;
-
-  /**
-   * Find a hook using its name
-   */
-  hook(): any;
-
-  /**
-   * Getter for the Strapi APIs container
-   *
-   * It returns all the registered APIs
-   */
-  readonly api: any;
-
-  /**
-   * Strapi Register Lifecycle.
-   *
-   * - Load
-   *   - The user application
-   *   - The plugins
-   *   - The admin
-   *   - The APIs
-   *   - The components
-   *   - The middlewares
-   *   - The policies
-   * - Trigger Strapi internal bootstrap
-   * - Create the webhooks runner
-   * - Create the internal hooks registry.
-   * - Init the telemetry cron job and middleware
-   * - Run all the `register` lifecycle methods loaded by the user application or the enabled plugins
-   */
-  register(): Promise<Strapi>;
-
-  /**
-   * Bootstraping phase.
-   *
-   * - Load all the content types
-   * - Initialize the database layer
-   * - Initialize the entity service
-   * - Run the schemas/database synchronization
-   * - Start the webhooks and initializing middlewares and routes
-   * - Run all the `bootstrap` lifecycle methods loaded by the
-   * user application or the enabled plugins
-   */
-  bootstrap(): Promise<Strapi>;
-
-  /**
-   * Destroy phase
-   *
-   * - Destroy Strapi server
-   * - Run all the `destroy` lifecycle methods loaded by the
-   * user application or the enabled plugins
-   * - Cleanup the event hub
-   * - Gracefully stop the database
-   * - Stop the telemetry and cron instance
-   * - Cleanup the global scope by removing global.strapi
-   */
-  destroy(): Promise<void>;
-
-  /**
-   * Run all functions registered for a given lifecycle. (Strapi core, user app, plugins)
-   */
-  runLifecyclesFunctions<T extends Lifecycles[keyof Lifecycles]>(lifecycleName: T): Promise<void>;
-
-  /**
-   * Load the application if needed and start the server
-   */
-  start(): Promise<void>;
-
-  /**
-   * Stop the server and provide a custom error and message
-   */
-  stopWithError<TError = unknown>(error: TError, customMessage?: string): void;
-
-  /**
-   * Gracefully stop the server
-   * Call the destroy method.
-   */
-  stop(code?: number): void;
-
-  /**
-   * Load the server and the user application.
-   * It basically triggers the register and bootstrap phases
-   */
-  load(): Promise<Strapi>;
-
-  /**
-   * Restart the server and reload all the configuration.
-   * It re-runs all the lifecycles phases.
-   *
-   * @example
-   * ``` ts
-   * setImmediate(() => strapi.reload());
-   * ```
-   */
-  reload(): () => void;
-
-  /**
-   * Initialize and start all the webhooks registered in the webhook store
-   */
-  startWebhooks(): Promise<void>;
-
-  /**
-   * Method called when the server is fully initialized and listen to incomming requests.
-   * It handles tasks such as logging the startup message
-   * or automatically opening the administration panel.
-   */
-  postListen(): Promise<void>;
-
-  /**
-   * Start listening for incomming requests
-   */
-  listen(): Promise<void | Error>;
-
-  /**
-   * Opent he administration panel in a browser if the option is enabled.
-   * You can disable it using the admin.autoOpen configuration variable.
-   *
-   * Note: It only works in development envs.
-   */
-  openAdmin(options: { isInitialized: boolean }): Promise<void>;
-
-  /**
-   * Load the admin panel server logic into the server code and initialize its configuration.
-   */
-  loadAdmin(): Promise<void>;
-
-  /**
-   * Resolve every enabled plugin and load them into the application.
-   */
-  loadPlugins(): Promise<void>;
-
-  /**
-   * Load every global policies in the policies container by
-   * reading from the `strapi.dirs.dist.policies` directory.
-   */
-  loadPolicies(): Promise<void>;
-
-  /**
-   * Load every APIs and their components (config, routes, controllers, services,
-   * policies, middlewares, content-types) in the API container.
-   */
-  loadAPIs(): Promise<void>;
-
-  /**
-   * Resolve every components in the user application and store them in `strapi.components`
-   */
-  loadComponents(): Promise<void>;
-
-  /**
-   * Load every global and core middlewares in the middlewares container by
-   * reading from the `strapi.dirs.dist.middlewares` and internal middlewares directory.
-   */
-  loadMiddlewares(): Promise<void>;
-
-  /**
-   * Load the user application in the server by reading the `src/index.js` file.
-   */
-  loadApp(): Promise<void>;
-
-  /**
-   * Add internal hooks to the hooks container.
-   * Those hooks are meant for internal usage and might break in future releases.
-   */
-  registerInternalHooks(): void;
-
-  /**
-   * Find a model (content-type, component) based on its unique identifier.
-   */
-  getModel(uid: string): any;
-
-  /**
-   * Binds database queries for a specific model based on its unique identifier.
-   */
-  query(uid: string): any;
-
-  /**
-   * Main Strapi container holding all the registries and providers (config, content-types, services, policies, etc...)
-   */
-  container: any;
-
-  /**
-   * References to all the directories handled by Strapi
-   */
-  dirs: StrapiDirectories;
-
-  /**
-   * Internal flag used to check if the application has been loaded
-   */
-  isLoaded: boolean;
-
-  /**
-   * Fully reload the application
-   */
-  reload(): void;
-
-  /**
-   * Holds a reference to the Koa application and the http server used by Strapi
-   */
-  server: any;
-
-  /**
-   * Strapi util used to manage application files
-   */
-  fs: any;
-
-  /**
-   * Event hub used to send and receive events from anywhere in the application
-   */
-  eventHub: any;
-
-  /**
-   * Internal util used to log stats and messages on application Startup
-   */
-  startupLogger: any;
-
-  /**
-   * Strapi logger used to send errors, warning or information messages
-   */
-  log: any;
-
-  /**
-   * Used to manage cron within Strapi
-   */
-  cron: any;
-
-  /**
-   * Telemetry util used to collect anonymous data on the application usage
-   */
-  telemetry: any;
-
-  /**
-   * Used to access ctx from anywhere within the Strapi application
-   */
-  requestContext: any;
-
-  /**
-   * Strapi DB layer instance
-   */
-  db: Database;
-
-  /**
-   * Core Store accessor
-   */
-  store: any;
-
-  /**
-   * Entity Validator instance
-   */
-  entityValidator: any;
-
-  /**
-   * Entity Service instance
-   */
-  entityService: EntityService.EntityService;
-}
-
-export interface Lifecycles {
-  REGISTER: 'register';
-  BOOTSTRAP: 'bootstrap';
-  DESTROY: 'destroy';
-}
-
-export interface StrapiDirectories {
-  static: {
-    public: string;
-  };
-  app: {
-    root: string;
-    src: string;
-    api: string;
-    components: string;
-    extensions: string;
-    policies: string;
-    middlewares: string;
-    config: string;
-  };
-  dist: {
-    root: string;
-    src: string;
-    api: string;
-    components: string;
-    extensions: string;
-    policies: string;
-    middlewares: string;
-    config: string;
-  };
-}