@content-island/api-client 0.8.0 → 0.8.2

package/README.md

@@ -22,159 +22,20 @@ interface Post {
 ```
 
 ```typescript
-import { createClient, mapContentToModel } from '@content-island/api-client';
+import { createClient } from '@content-island/api-client';
 
 const client = createClient({ accessToken: <your-token>});
 
-const postContents = client.getContentList({ contentType: 'post'}); // Retrieve the list of contents in the project filtered by content type, for example 'post'
-const englishPosts = postContents.map(content => mapContentToModel<Post>(content, 'en')); // Map the english content to your own model
-const spanishPosts = postContents.map(content => mapContentToModel<Post>(content, 'es')); // Map the spanish content to your own model
+const postsWithDefaultLanguage = client.getContentList<Post>({ contentType: 'post'}); // Retrieve the list of contents in the project filtered by content type, for example 'post' in the
+const englishPosts = client.getContentList<Post>({ contentType: 'post', language: 'en'}); // Get english posts
+const spanishPosts = client.getContentList<Post>({ contentType: 'post', language: 'es'}); // Get spanish posts
 
 // Or you can retrieve a content by id
-const content = client.getContent('content-id'); // Retrieve a content by id
-const englishPost = mapContentToModel<Post>(content, 'en'); // Map the english content to your own model
-const spanishPost = mapContentToModel<Post>(content, 'es'); // Map the spanish content to your own model
+const postById = client.getContent<Post>({ id: 'content-id', language: 'es' }); // Retrieve a content by id
+const postBySomeField = client.getContent<Post>({ 'fields.title': 'post-title', language: 'es' }); // Retrieve a content by field value
 
 ```
 
-### Filter by language
+### Documentation
 
-```typescript
-import { createClient, mapContentToModel } from '@content-island/api-client';
-
-const client = createClient({ accessToken: <your-token>});
-
-const englishPostContents = client.getContentList({ contentType: 'post', language: 'en'}); // Retrieve the english posts
-const englishPosts = englishPostContents.map(content => mapContentToModel<Post>(content)); // Map content to your own model using the first language available, in this case 'en'
-
-// Or you can retrieve contents by multiple languages
-const postContents = client.getContentList({ contentType: 'post', language: { in: ['en', 'es']}}); // Retrieve the english or spanish posts
-
-// Or you can retrieve a content by id
-const englishContent = client.getContent('content-id', { language: 'en'}); // Retrieve a content by id
-const englishPost = mapContentToModel<Post>(englishContent); // Map content to your own model using the first language available, in this case 'en'
-
-```
-
-> Check the [API/queryParams](#queryparams) section for more information about the query parameters.
-
-## API
-
-### `createClient(options): endpoints`
-
-Creates a client instance.
-
-#### `options`
-
-| name          | type     | required | description                                                 |
-| ------------- | -------- | -------- | ----------------------------------------------------------- |
-| `accessToken` | `string` | `true`   | The access token of the project                             |
-| `domain`      | `string` | `false`  | The domain of the project. Default: `api.contentisland.net` |
-| `apiVersion`  | `string` | `false`  | The version of the API. Default: `1.0`                      |
-
-#### `endpoints`
-
-##### `getProject()`
-
-Retrieves the project details by access token.
-
-##### `getContentList(queryParams?)`
-
-Retrieves the list of contents in the project.
-
-##### `getContent(id, queryParams?)`
-
-Retrieves a content by id.
-
-#### `queryParams`
-
-The query parameters to filter the list of contents.
-
-| Key           | Value    | Description                                                                                                                                                |
-| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id`          | `Filter` | The id of the content to retrieve. This is useful to retrieve a list of contents by id. For example: `client.getContentList({ id: { in: ['1', '2', '3']})` |
-| `contentType` | `Filter` | The content type to filter the list of contents. For example: `post`                                                                                       |
-| `language`    | `Filter` | The language to filter the list of contents. For example: `en`                                                                                             |
-
-| Filter type        | Description                                                        | Example                              |
-| ------------------ | ------------------------------------------------------------------ | ------------------------------------ |
-| `string`           | Filter the content where the param is `equal to` this value        | `{ contentType: 'post' }`            |
-| `{ in: string[] }` | Filter the content where the param `contains some` of these values | `{ language: { in: ['en', 'es'] } }` |
-
-### `mapContentToModel(content, language?)`
-
-Maps a list of fields to a model.
-
-```typescript
-const content: Content = {
-  id: '1',
-  contentType: { id: '10', name: 'post' },
-  lastUpdate: '2023-10-20T00:00:00.000Z',
-  fields: [
-    {
-      id: '100',
-      name: 'title',
-      value: 'My title',
-      type: 'short-text',
-      isArray: false,
-      language: 'en',
-    },
-    {
-      id: '200',
-      name: 'body',
-      value: '# My long text in markdown',
-      type: 'long-text',
-      isArray: false,
-      language: 'en',
-    },
-    {
-      id: '300',
-      name: 'order',
-      value: 1,
-      type: 'number',
-      isArray: false,
-      language: 'en',
-    },
-    {
-      id: '400',
-      name: 'title',
-      value: 'Mi titutlo',
-      type: 'short-text',
-      isArray: false,
-      language: 'es',
-    },
-    {
-      id: '500',
-      name: 'body',
-      value: '# Mi texto largo en markdown',
-      type: 'long-text',
-      isArray: false,
-      language: 'es',
-    },
-    {
-      id: '600',
-      name: 'order',
-      value: 1,
-      type: 'number',
-      isArray: false,
-      language: 'es',
-    },
-  ],
-};
-
-interface Post {
-  id: string;
-  title: string;
-  body: string;
-  order: number;
-}
-
-const post = mapContentToModel<Post>(fields); // Get the first language available, in this case 'en'
-console.log(post); // { id: '1', title: 'My title', body: '# My long text in markdown', order: 1 }
-
-const englishPost = mapContentToModel<Post>(fields, 'en');
-console.log(englishPost); // { id: '1', title: 'My title', body: '# My long text in markdown', order: 1 }
-
-const spanishPost = mapContentToModel<Post>(fields, 'es');
-console.log(spanishPost); // { id: '1', title: 'Mi titulo', body: '# Mi texto largo en markdown', order: 1 }
-```
+For more detailed documentation, please refer to the [Content Island API Client documentation](https://docs.contentisland.net/client-api/overview/).

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+import { FieldType } from '@content-island/common';
+import { Lookup } from '@content-island/common';
+import { Media } from '@content-island/common';
+
 declare type AllowedQueryKeys<M extends Model = Model> = keyof Pick<
 Query<M>,
 'id' | 'contentType' | 'language' | Extract<keyof Query<M>, `fields.${string}`>
@@ -11,20 +15,26 @@ export declare interface ApiClient {
     getRawContent: <M extends Model = Model & Record<string, any>>(queryParam: QueryParams<M>) => Promise<Content>;
 }
 
-export declare interface ApiLookup {
-    id: string;
-    name: string;
-}
-
 export declare type ClientFilter<Type = string> = Type | { in?: Type[] };
 
 export declare interface Content {
     id: string;
-    contentType: ApiLookup;
+    contentType: Lookup;
     lastUpdate: Date;
     fields: Field[];
 }
 
+declare interface ContentType extends Lookup {
+    fields: ContentTypeField[];
+}
+
+declare interface ContentTypeField extends Lookup {
+    type: FieldType;
+    tsType: string;
+    isArray: boolean;
+    isRequired?: boolean;
+}
+
 export declare const createClient: (options: Options) => ApiClient;
 
 export declare interface Field {
@@ -36,16 +46,15 @@ export declare interface Field {
     language: string;
 }
 
-export declare type FieldType = 'short-text' | 'long-text' | 'number' | 'date' | 'date-time' | 'media' | 'boolean';
+export { FieldType }
+
+export { Lookup }
 
 export declare const mapContentToModel: <M extends Model<Language> = Model<any> & Record<string, any>, Language = M["language"]>(content: Content, language?: Language) => M;
 
-export declare interface Media {
-    name: string;
-    url: string;
-}
+export { Media }
 
-declare type Model<Language = string> = {
+export declare type Model<Language = string> = {
     id: string;
     language?: Language;
 };
@@ -61,7 +70,7 @@ export declare interface Project {
     id: string;
     name: string;
     languages: string[];
-    contentTypes?: ApiLookup[];
+    contentTypes?: ContentType[];
 }
 
 declare type Query<M extends Model = Model> = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/api-client",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Content Island - REST API Client",
   "private": false,
   "sideEffects": false,