@datocms/cma-client 0.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export { ApiError, LogLevel } from '@datocms/rest-client-utils';
+export { Client } from './generated/Client';
+export * as Resources from './generated/resources';
+export type { ClientConfigOptions } from './generated/Client';
+export * from './buildClient';
+export * from './buildBlockRecord';
+export * as SchemaTypes from './generated/SchemaTypes';
+export * as SimpleSchemaTypes from './generated/SimpleSchemaTypes';

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@datocms/cma-client",
+  "version": "0.1.0",
+  "description": "JS client for DatoCMS REST Content Management API",
+  "keywords": [
+    "datocms",
+    "client"
+  ],
+  "author": "Stefano Verna <s.verna@datocms.com>",
+  "homepage": "https://github.com/datocms/js-toolkit/tree/main/packages/cma-client#readme",
+  "license": "MIT",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "typings": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "directories": {
+    "lib": "dist",
+    "test": "__tests__"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/datocms/js-toolkit.git"
+  },
+  "scripts": {
+    "build": "tsc && tsc --project ./tsconfig.esnext.json",
+    "prebuild": "rimraf dist"
+  },
+  "bugs": {
+    "url": "https://github.com/datocms/js-toolkit/issues"
+  },
+  "dependencies": {
+    "@datocms/rest-client-utils": "^0.1.0"
+  },
+  "devDependencies": {
+    "@datocms/dashboard-client": "^0.1.0"
+  },
+  "gitHead": "41036fc6a62b20638bf91f8c9f58ff8ebabb69bf"
+}

package/src/BaseResource.ts

@@ -0,0 +1,9 @@
+import { Client } from './generated/Client';
+
+export default class BaseResource {
+  client: Client;
+
+  constructor(client: Client) {
+    this.client = client;
+  }
+}

package/src/buildBlockRecord.ts

@@ -0,0 +1,12 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SimpleSchemaTypes from './generated/SimpleSchemaTypes';
+import * as SchemaTypes from './generated/SchemaTypes';
+import { Item } from './generated/resources';
+
+export function buildBlockRecord(body: SimpleSchemaTypes.ItemUpdateSchema) {
+  return Utils.serializeRequestBody<SchemaTypes.ItemUpdateSchema>(body, {
+    type: Item.TYPE,
+    attributes: '*',
+    relationships: ['item_type'],
+  }).data;
+}

package/src/buildClient.ts

@@ -0,0 +1,5 @@
+import { Client, ClientConfigOptions } from './generated/Client';
+
+export function buildClient(config: ClientConfigOptions) {
+  return new Client(config);
+}

package/src/generated/Client.ts

@@ -0,0 +1,156 @@
+import * as Resources from './resources';
+import { request, pollJobResult, LogLevel } from '@datocms/rest-client-utils';
+import { JobResult } from './SimpleSchemaTypes';
+
+export type RequestOptions = {
+  method: 'GET' | 'PUT' | 'POST' | 'DELETE';
+  url: string;
+  queryParams?: Record<string, unknown>;
+  body?: unknown;
+  preCallStack?: string;
+};
+
+export type ClientConfigOptions = {
+  apiToken: string | null;
+  baseUrl?: string;
+  environment?: string;
+  extraHeaders?: Record<string, string>;
+  logLevel?: LogLevel;
+  autoRetry?: boolean;
+};
+
+export class Client {
+  static readonly defaultBaseUrl = 'https://site-api.datocms.com';
+
+  roles: Resources.Role;
+  users: Resources.User;
+  ssoUsers: Resources.SsoUser;
+  auditLogEvents: Resources.AuditLogEvent;
+  menuItems: Resources.MenuItem;
+  itemTypes: Resources.ItemType;
+  fields: Resources.Field;
+  fieldsets: Resources.Fieldset;
+  session: Resources.Session;
+  accessTokens: Resources.AccessToken;
+  plugins: Resources.Plugin;
+  jobResults: Resources.JobResult;
+  subscriptionLimits: Resources.SubscriptionLimit;
+  subscriptionFeatures: Resources.SubscriptionFeature;
+  buildEvents: Resources.BuildEvent;
+  items: Resources.Item;
+  itemVersions: Resources.ItemVersion;
+  uploads: Resources.Upload;
+  uploadRequest: Resources.UploadRequest;
+  scheduledPublication: Resources.ScheduledPublication;
+  scheduledUnpublishing: Resources.ScheduledUnpublishing;
+  searchResults: Resources.SearchResult;
+  environments: Resources.Environment;
+  maintenanceMode: Resources.MaintenanceMode;
+  webhooks: Resources.Webhook;
+  webhookCalls: Resources.WebhookCall;
+  buildTriggers: Resources.BuildTrigger;
+  itemTypeFilters: Resources.ItemTypeFilter;
+  uploadFilters: Resources.UploadFilter;
+  siteInvitations: Resources.SiteInvitation;
+  editingSessions: Resources.EditingSession;
+  ssoGroups: Resources.SsoGroup;
+  ssoSettings: Resources.SsoSettings;
+  whiteLabelSettings: Resources.WhiteLabelSettings;
+  publicInfo: Resources.PublicInfo;
+  dailyUsages: Resources.DailyUsage;
+  usageCounters: Resources.UsageCounter;
+  uploadTags: Resources.UploadTag;
+  uploadSmartTags: Resources.UploadSmartTag;
+  site: Resources.Site;
+  workflows: Resources.Workflow;
+
+  config: ClientConfigOptions;
+  jobResultsFetcher?: (jobId: string) => Promise<JobResult>;
+
+  private cachedEventsChannelName: string | undefined;
+
+  constructor(config: ClientConfigOptions) {
+    this.config = config;
+    this.roles = new Resources.Role(this);
+    this.users = new Resources.User(this);
+    this.ssoUsers = new Resources.SsoUser(this);
+    this.auditLogEvents = new Resources.AuditLogEvent(this);
+    this.menuItems = new Resources.MenuItem(this);
+    this.itemTypes = new Resources.ItemType(this);
+    this.fields = new Resources.Field(this);
+    this.fieldsets = new Resources.Fieldset(this);
+    this.session = new Resources.Session(this);
+    this.accessTokens = new Resources.AccessToken(this);
+    this.plugins = new Resources.Plugin(this);
+    this.jobResults = new Resources.JobResult(this);
+    this.subscriptionLimits = new Resources.SubscriptionLimit(this);
+    this.subscriptionFeatures = new Resources.SubscriptionFeature(this);
+    this.buildEvents = new Resources.BuildEvent(this);
+    this.items = new Resources.Item(this);
+    this.itemVersions = new Resources.ItemVersion(this);
+    this.uploads = new Resources.Upload(this);
+    this.uploadRequest = new Resources.UploadRequest(this);
+    this.scheduledPublication = new Resources.ScheduledPublication(this);
+    this.scheduledUnpublishing = new Resources.ScheduledUnpublishing(this);
+    this.searchResults = new Resources.SearchResult(this);
+    this.environments = new Resources.Environment(this);
+    this.maintenanceMode = new Resources.MaintenanceMode(this);
+    this.webhooks = new Resources.Webhook(this);
+    this.webhookCalls = new Resources.WebhookCall(this);
+    this.buildTriggers = new Resources.BuildTrigger(this);
+    this.itemTypeFilters = new Resources.ItemTypeFilter(this);
+    this.uploadFilters = new Resources.UploadFilter(this);
+    this.siteInvitations = new Resources.SiteInvitation(this);
+    this.editingSessions = new Resources.EditingSession(this);
+    this.ssoGroups = new Resources.SsoGroup(this);
+    this.ssoSettings = new Resources.SsoSettings(this);
+    this.whiteLabelSettings = new Resources.WhiteLabelSettings(this);
+    this.publicInfo = new Resources.PublicInfo(this);
+    this.dailyUsages = new Resources.DailyUsage(this);
+    this.usageCounters = new Resources.UsageCounter(this);
+    this.uploadTags = new Resources.UploadTag(this);
+    this.uploadSmartTags = new Resources.UploadSmartTag(this);
+    this.site = new Resources.Site(this);
+    this.workflows = new Resources.Workflow(this);
+  }
+
+  get baseUrl() {
+    return this.config.baseUrl || Client.defaultBaseUrl;
+  }
+
+  request<T>(options: RequestOptions) {
+    return request<T>({
+      ...this.config,
+      ...options,
+      userAgent: `@datocms/cma-client`,
+      baseUrl: this.baseUrl,
+      preCallStack: new Error().stack,
+      extraHeaders: {
+        ...(this.config.extraHeaders || {}),
+        ...(this.config.environment
+          ? { 'X-Environment': this.config.environment }
+          : {}),
+        'X-API-Version': '3',
+      },
+      fetchJobResult: (jobId: string) => {
+        return this.jobResultsFetcher
+          ? this.jobResultsFetcher(jobId)
+          : pollJobResult(() => this.jobResults.find(jobId));
+      },
+    });
+  }
+
+  async eventsChannelName() {
+    if (this.cachedEventsChannelName) {
+      return this.cachedEventsChannelName;
+    }
+
+    const { data: site } = await this.site.rawFind();
+
+    this.cachedEventsChannelName = this.config.environment
+      ? `private-site-${site.id}-environment-${this.config.environment}`
+      : `private-site-${site.id}`;
+
+    return this.cachedEventsChannelName;
+  }
+}