@directus/app 9.0.0-rc.96 → 9.0.0-rc.97

package/dist/assets/collections.6094fb06.js

@@ -1,444 +0,0 @@
-var n=`---
-pageClass: page-reference
----
-
-# Collections
-
-<div class="two-up">
-<div class="left">
-
-> Collections are the individual collections of items, similar to tables in a database. Changes to collections will
-> alter the schema of the database. [Learn more about Collections](/concepts/collections/).
-
-</div>
-<div class="right">
-
-[[toc]]
-
-</div>
-</div>
-
----
-
-## The Collection Object
-
-<div class="two-up">
-<div class="left">
-<div class="definitions">
-
-\`collection\` **string**\\
-Name of the collection. This matches the table name in the database.
-
-</div>
-
-#### Meta
-
-Directus metadata, primarily used in the Admin App.
-
-<div class="definitions">
-
-\`collection\` **string**\\
-Name of the collection. This matches the table name in the database.
-
-\`icon\` **string**\\
-Icon displayed in the Admin App when working with this collection.
-
-\`note\` **string**\\
-Short description displayed in the Admin App.
-
-\`display_template\` **string**\\
-How items in this collection should be displayed when viewed relationally in the Admin App.
-
-\`hidden\` **boolean**\\
-Whether or not this collection is hidden in the Admin App.
-
-\`singleton\` **boolean**\\
-Whether or not this collection is treated as a singleton.
-
-\`translations\` **array**\\
-How this collection's name is displayed in the different languages in the Admin App.
-
-\`archive_field\` **string**\\
-What field in the collection holds the archived state.
-
-\`archive_value\` **string**\\
-What value the archive field should be set to when archiving an item.
-
-\`unarchive_value\` **string**\\
-What value the archive field should be set to when unarchiving an item.
-
-\`archive_app_filter\` **boolean**\\
-Whether or not the Admin App should allow the user to view archived items.
-
-\`sort_field\` **boolean**\\
-What field holds the sort value on the collection. The Admin App uses this to allow drag-and-drop manual sorting.
-
-</div>
-
-#### Schema
-
-"Raw" database information. Based on the database vendor used, different information might be returned. The following
-are available for all drivers.
-
-<div class="definitions">
-
-\`name\` **string**\\
-The table name.
-
-\`comment\` **string**\\
-The table comment.
-
-</div>
-</div>
-<div class="right">
-
-\`\`\`json
-{
-	"collection": "articles",
-	"meta": {
-		"collection": "articles",
-		"icon": "article",
-		"note": "Blog posts",
-		"display_template": "{{ title }}",
-		"hidden": false,
-		"singleton": false,
-		"translations": [
-			{
-				"language": "en-US",
-				"translation": "Articles"
-			},
-			{
-				"language": "nl-NL",
-				"translation": "Artikelen"
-			}
-		],
-		"archive_field": "status",
-		"archive_value": "archived",
-		"unarchive_value": "draft",
-		"archive_app_filter": true,
-		"sort_field": "sort"
-	},
-	"schema": {
-		"name": "pages",
-		"comment": null
-	}
-}
-\`\`\`
-
-</div>
-</div>
-
----
-
-## List Collections
-
-List the available collections.
-
-<div class="two-up">
-<div class="left">
-
-### Query Parameters
-
-This endpoint doesn't currently support any query parameters.
-
-### Returns
-
-An array of [collection objects](#the-collection-object).
-
-</div>
-<div class="right">
-
-### REST API
-
-\`\`\`
-GET /collections
-SEARCH /collections
-\`\`\`
-
-[Learn more about SEARCH ->](/reference/api/introduction/#search-http-method)
-
-### GraphQL
-
-\`\`\`
-POST /graphql/system
-\`\`\`
-
-\`\`\`graphql
-type Query {
-	collections: [directus_collections]
-}
-\`\`\`
-
-##### Example
-
-\`\`\`graphql
-query {
-	collections {
-		...
-	}
-}
-\`\`\`
-
-</div>
-</div>
-
----
-
-## Retrieve a Collection
-
-Retrieve a single collection by table name.
-
-<div class="two-up">
-<div class="left">
-
-### Query Parameters
-
-This endpoint doesn't currently support any query parameters.
-
-### Returns
-
-A [collection object](#the-collection-object).
-
-</div>
-<div class="right">
-
-### REST API
-
-\`\`\`
-GET /collections/:collection
-\`\`\`
-
-##### Example
-
-\`\`\`
-GET /collections/articles
-\`\`\`
-
-### GraphQL
-
-\`\`\`
-POST /graphql/system
-\`\`\`
-
-\`\`\`graphql
-type Query {
-	collections_by_name(name: String!): directus_collections
-}
-\`\`\`
-
-##### Example
-
-\`\`\`graphql
-query {
-	collections_by_name(name: "articles") {
-		...
-	}
-}
-\`\`\`
-
-</div>
-</div>
-
----
-
-## Create a Collection
-
-Create a new Collection. This will create a new table in the database as well.
-
-<div class="two-up">
-<div class="left">
-
-### Query Parameters
-
-This endpoint doesn't currently support any query parameters.
-
-### Request Body
-
-The \`collection\` property is required, all other properties of the [collection object](#the-collection-object) are
-optional.
-
-You are able to provide an array of \`fields\` to be created during the creation of the collection. See the
-[fields object](/reference/api/system/fields/#the-fields-object) for more information on what properties are available
-in a field.
-
-### Returns
-
-The [collection object](#the-collection-object) for the collection created in this request.
-
-</div>
-<div class="right">
-
-### REST API
-
-\`\`\`
-POST /collections
-\`\`\`
-
-##### Example
-
-\`\`\`json
-// POST /collections
-
-{
-	"collection": "testimonials",
-	"meta": {
-		"icon": "format_quote"
-	}
-}
-\`\`\`
-
-### GraphQL
-
-\`\`\`
-POST /graphql/system
-\`\`\`
-
-\`\`\`graphql
-type Mutation {
-	create_collections_item(data: directus_collections): directus_collections
-}
-\`\`\`
-
-##### Example
-
-\`\`\`graphql
-mutation {
-	create_collections_item(data: {
-		collection: "testimonials",
-		meta: {
-			icon: "format_quote"
-		}
-	}) {
-		...
-	}
-}
-\`\`\`
-
-</div>
-</div>
-
----
-
-## Update a Collection
-
-Update the metadata for an existing collection.
-
-<div class="two-up">
-<div class="left">
-
-### Query Parameters
-
-This endpoint doesn't currently support any query parameters.
-
-### Request Body
-
-You can only update the \`meta\` values of the the [collection object](#the-collection-object). Updating the collection
-name is not supported at this time.
-
-### Returns
-
-The [collection object](#the-collection-object) for the updated collection in this request.
-
-</div>
-<div class="right">
-
-### REST API
-
-\`\`\`
-PATCH /collections/:collection
-\`\`\`
-
-##### Example
-
-\`\`\`json
-// PATCH /collections/testimonials
-
-{
-	"meta": {
-		"note": "Short quotes from happy customers."
-	}
-}
-\`\`\`
-
-### GraphQL
-
-\`\`\`
-POST /graphql/system
-\`\`\`
-
-\`\`\`graphql
-type Mutation {
-	update_collections_item(collection: String!, data: update_directus_collections_input!): directus_collections
-}
-\`\`\`
-
-##### Example
-
-\`\`\`graphql
-mutation {
-	update_collections_item(collection: "testimonials", data: { meta: { note: "Short quotes from happy customers." } }) {
-		collection
-	}
-}
-\`\`\`
-
-</div>
-</div>
-
----
-
-## Delete a Collection
-
-Delete a collection.
-
-<div class="two-up">
-<div class="left">
-
-::: danger Destructive
-
-Be aware, this will delete the table from the database, including all items in it. This action can't be undone.
-
-:::
-
-</div>
-<div class="right">
-
-### REST API
-
-\`\`\`
-DELETE /collections/:collection
-\`\`\`
-
-##### Example
-
-\`\`\`
-DELETE /collections/articles
-\`\`\`
-
-### GraphQL
-
-\`\`\`
-POST /graphql/system
-\`\`\`
-
-\`\`\`graphql
-type Mutation {
-	delete_collections_item(collection: String!): delete_collection
-}
-\`\`\`
-
-##### Example
-
-\`\`\`graphql
-mutation {
-	delete_collections_item(collection: "articles") {
-		collection
-	}
-}
-\`\`\`
-
-</div>
-</div>
-
----
-`;export{n as default};

package/dist/assets/collections.f11b9b9c.js

@@ -1,160 +0,0 @@
-var e=`# Collections
-
-> Collections are containers for specific groupings of Items. Each collection represents a **table** in your database.
-> [Learn more about Collections](/concepts/collections/).
-
-## Creating a Collection
-
-1. Navigate to **Settings > Data Model**
-2. Click the **Create Collection** action button in the header
-3. Enter a unique **Collection Name**, keeping in mind that this is entered as a _key_ that determines the database
-   table name, and is then presented in the App using the internal Title Formatter.
-4. Optional: Configure the collection's **Primary Key** name and type.
-   - Auto-Incremented Integer
-   - Generated UUID
-   - Manually Entered String
-5. Optional: Enable and rename any desired **System Fields**.
-   - Status
-   - Sort
-   - Created On
-   - Created By
-   - Updated On
-   - Updated By
-6. Click the **Finish Setup** button
-
-::: danger Immutable Keys
-
-The collection name, primary key name/type, and system field names can not be modified after the collection is created.
-
-:::
-
-::: tip Database Tables
-
-Keep in mind that a Directus Collection is just a database table. Therefore you can import or create a table directly in
-the database, and it will automatically appear within Directus. The first time you manage that table, a
-\`directus_collections\` record will be created with default values.
-
-:::
-
-## Configuring a Collection
-
-1. Navigate to **Settings > Data Model > [Collection Name]**
-2. Configure the following settings:
-   - **Collection Name** \u2014 This is the key for the collection. It can not be modified, but you can override it with
-     Translations (see field below).
-   - **Icon** \u2014 The icon used throughout the App when referencing this collection
-   - **Note** \u2014 A helpful note that explains the collection's purpose
-   - **Display Template** \u2014 A [Field Template](#) that creates dynamic titles for the collection's items
-   - **Hidden** \u2014 Toggles if the collection should be globally hidden. Keep in mind that Admin roles can always see all
-     collections.
-   - **Singleton** \u2014 For collections that will only contain a single item (eg: an "About Us" form), the
-     [Collection Detail](/concepts/application/#collection-detail) will be bypassed, and users are taken directly to the
-     [Item Detail](/concepts/application/#item-detail) page.
-   - **Translation** \u2014 Allows translating the collection name into different languages. These
-     [Schema Translations](/concepts/translations/#schema-translations) are important for multilingual projects. You can
-     also "translate" a collection name into the default language \u2014 helpful for renaming technical table names.
-3. **Create and configure any fields** within this Collection.
-   - [Creating a Field](/guides/fields/#creating-a-field)
-   - [Updating a Field](/guides/fields/#updating-a-field)
-   - [Deleting a Field](/guides/fields/#deleting-a-field)
-   - [Duplicating a Field](/guides/fields/#duplicating-a-field)
-   - [Changing Field Order & Layout](/guides/fields/#adjusting-field-layout)
-4. Optional: Configure the [Archive](#archive) and [Sort](#sort) options below.
-
-### Archive
-
-The archive feature allows you to enable the collection with a custom soft-delete option. Soft-delete allows users to
-remove items from the App, but maintains the actual database record for easy recovery.
-
-- **Archive Field** \u2014 The field that holds the archive value
-- **Archive App Filter** \u2014 Allows users to view archived items
-- **Archive Value** \u2014 The value saved in the Archive Field when archived
-- **Unarchive Value** \u2014 The value saved in the Archive Field when unarchived
-
-::: warning API Responses
-
-Items that have been archived are still returned normally via the API. It is up to you to filter them out as needed.
-
-:::
-
-::: tip Automatic Setup
-
-When creating a new Collection, you have the option of creating an optional "Status" field. If you choose to include
-this field, the collection's archive settings will automatically be configured for you.
-
-:::
-
-### Sort
-
-The sort feature enables manual drag-and-drop item reordering within the Directus App. This is typically shown on the
-[Collection Detail](/concepts/application/#collection-detail) page/modal, and can also be used for sorting items within
-a [Junction Table](/concepts/relationships/#many-to-many-m2m).
-
-To configure manual sorting for a collection:
-
-1. Navigate to **Settings > Data Model > [Collection Name]**
-2. Create a field with the **Integer** type
-   - Optional: Set the field to be **Hidden**
-3. Select the field you just created in the **Sort Field** dropdown
-
-::: tip Automatic Setup
-
-When creating a new Collection, you have the option of creating an optional "Sort" field. If you choose to include this
-field, the collection's sort settings will automatically be configured for you.
-
-:::
-
-::: tip Interface Sorting
-
-To configure manual sorting within an Interface (eg: M2M, O2M, or M2A), configure as above, but also set the **Sort
-Field** on the field's Relationship pane.
-
-:::
-
-## Renaming a Collection
-
-While you can not change the **Key** of a collection via Directus (as of now), you can change its **Name** and
-translations.
-
-1. Navigate to **Settings > Data Model > [Collection Name]**
-2. Click the Add New button under **Collection Name Translations**
-3. Choose the desired **Language** (your primary language for "renaming")
-4. Enter a **Translation**
-5. Click the **Save** button
-
-::: tip Special Casing
-
-If you are trying to update the specific casing (uppercase/lowercase) for a word (eg: \`Dna\` to \`DNA\`) you will want to
-add the edge-case to the
-[Format Title package](https://github.com/directus/directus/tree/main/packages/format-title/src). If you feel the case
-passes our [80/20 rule](https://docs.directus.io/contributing/introduction/#feature-requests) you should submit a Pull
-Request to the codebase, otherwise you can update this in your instance.
-
-:::
-
-## Deleting a Collection
-
-1. Navigate to **Settings > Data Model > [Collection Name]**
-2. Click the red **Delete Collection** action button in the header
-3. Confirm this decision by clicking **Delete** in the dialog
-
-::: danger Irreversible Change
-
-This action is permanent and can not be undone. Please proceed with caution.
-
-:::
-
-## Adjusting a Collection Layout
-
-1. Navigate to **Collections > [Collection Name]**
-2. Click **"Layout Options"** in the Page Sidebar
-3. **Configure the Layout Options** as desired
-
-::: tip User Preferences
-
-Any changes made to the Collection Layout Options, page filters, search queries, and advanced filters, are instantly
-saved to your user preferences. This means that your experience will be the same when logging later, even if using a
-different device.
-
-:::
-`;export{e as default};