microcms-js-sdk 2.5.0 → 2.6.0

package/dist/cjs/types.d.ts

@@ -1,120 +0,0 @@
-export declare type Fetch = typeof fetch;
-/**
- * microCMS createClient params
- */
-export interface MicroCMSClient {
-    serviceDomain: string;
-    apiKey: string;
-    customFetch?: Fetch;
-    retry?: boolean;
-}
-declare type depthNumber = 1 | 2 | 3;
-/**
- * microCMS queries
- * https://document.microcms.io/content-api/get-list-contents#h9ce528688c
- * https://document.microcms.io/content-api/get-content#h9ce528688c
- */
-export interface MicroCMSQueries {
-    draftKey?: string;
-    limit?: number;
-    offset?: number;
-    orders?: string;
-    fields?: string | string[];
-    q?: string;
-    depth?: depthNumber;
-    ids?: string | string[];
-    filters?: string;
-    richEditorFormat?: 'html' | 'object';
-}
-/**
- * microCMS contentId
- * https://document.microcms.io/manual/content-id-setting
- */
-export interface MicroCMSContentId {
-    id: string;
-}
-/**
- * microCMS content common date
- */
-export interface MicroCMSDate {
-    createdAt: string;
-    updatedAt: string;
-    publishedAt?: string;
-    revisedAt?: string;
-}
-/**
- * microCMS image
- */
-export interface MicroCMSImage {
-    url: string;
-    width?: number;
-    height?: number;
-}
-/**
- * microCMS list api Response
- */
-export interface MicroCMSListResponse<T> {
-    contents: (T & MicroCMSListContent)[];
-    totalCount: number;
-    limit: number;
-    offset: number;
-}
-/**
- * microCMS list content common types
- */
-export declare type MicroCMSListContent = MicroCMSContentId & MicroCMSDate;
-/**
- * microCMS object content common types
- */
-export declare type MicroCMSObjectContent = MicroCMSDate;
-export interface MakeRequest {
-    endpoint: string;
-    contentId?: string;
-    queries?: MicroCMSQueries & Record<string, any>;
-    requestInit?: RequestInit;
-}
-export declare type CustomRequestInit = Omit<RequestInit, 'method' | 'headers' | 'body'>;
-export interface GetRequest {
-    endpoint: string;
-    contentId?: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetListDetailRequest {
-    endpoint: string;
-    contentId: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetListRequest {
-    endpoint: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetObjectRequest {
-    endpoint: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface WriteApiRequestResult {
-    id: string;
-}
-export interface CreateRequest<T> {
-    endpoint: string;
-    contentId?: string;
-    content: T;
-    isDraft?: boolean;
-    customRequestInit?: CustomRequestInit;
-}
-export interface UpdateRequest<T> {
-    endpoint: string;
-    contentId?: string;
-    content: Partial<T>;
-    customRequestInit?: CustomRequestInit;
-}
-export interface DeleteRequest {
-    endpoint: string;
-    contentId: string;
-    customRequestInit?: CustomRequestInit;
-}
-export {};

package/dist/cjs/utils/constants.d.ts

@@ -1,4 +0,0 @@
-export declare const BASE_DOMAIN = "microcms.io";
-export declare const API_VERSION = "v1";
-export declare const MAX_RETRY_COUNT = 2;
-export declare const MIN_TIMEOUT_MS = 5000;

package/dist/cjs/utils/isCheckValue.d.ts

@@ -1,14 +0,0 @@
-/**
- * Check object
- *
- * @param {unknown} value
- * @returns {boolean}
- */
-export declare const isObject: (value: unknown) => value is Record<string, unknown>;
-/**
- * Check string
- *
- * @param {unknown} value
- * @returns {boolean}
- */
-export declare const isString: (value: unknown) => value is string;

package/dist/cjs/utils/parseQuery.d.ts

@@ -1,2 +0,0 @@
-import { MicroCMSQueries } from '../types';
-export declare const parseQuery: (queries: MicroCMSQueries) => string;

package/dist/esm/createClient.d.ts

@@ -1,13 +0,0 @@
-import { MicroCMSClient, GetRequest, GetListRequest, GetListDetailRequest, GetObjectRequest, WriteApiRequestResult, CreateRequest, MicroCMSListResponse, MicroCMSListContent, MicroCMSObjectContent, UpdateRequest, DeleteRequest } from './types';
-/**
- * Initialize SDK Client
- */
-export declare const createClient: ({ serviceDomain, apiKey, customFetch, retry: retryOption, }: MicroCMSClient) => {
-    get: <T = any>({ endpoint, contentId, queries, customRequestInit, }: GetRequest) => Promise<T>;
-    getList: <T_1 = any>({ endpoint, queries, customRequestInit, }: GetListRequest) => Promise<MicroCMSListResponse<T_1>>;
-    getListDetail: <T_2 = any>({ endpoint, contentId, queries, customRequestInit, }: GetListDetailRequest) => Promise<T_2 & import("./types").MicroCMSContentId & import("./types").MicroCMSDate>;
-    getObject: <T_3 = any>({ endpoint, queries, customRequestInit, }: GetObjectRequest) => Promise<T_3 & import("./types").MicroCMSDate>;
-    create: <T_4 extends Record<string | number, any>>({ endpoint, contentId, content, isDraft, customRequestInit, }: CreateRequest<T_4>) => Promise<WriteApiRequestResult>;
-    update: <T_5 extends Record<string | number, any>>({ endpoint, contentId, content, customRequestInit, }: UpdateRequest<T_5>) => Promise<WriteApiRequestResult>;
-    delete: ({ endpoint, contentId, customRequestInit, }: DeleteRequest) => Promise<void>;
-};

package/dist/esm/index.d.ts

@@ -1,2 +0,0 @@
-export { createClient } from './createClient';
-export * from './types';

package/dist/esm/lib/fetch.d.ts

@@ -1,7 +0,0 @@
-import { Fetch } from 'src/types';
-export declare const resolveFetch: (customFetch?: Fetch) => Fetch;
-export declare const resolveHeadersConstructor: () => {
-    new (init?: HeadersInit | undefined): Headers;
-    prototype: Headers;
-};
-export declare const generateFetchClient: (apiKey: string, customFetch?: Fetch) => Fetch;

package/dist/esm/types.d.ts

@@ -1,120 +0,0 @@
-export declare type Fetch = typeof fetch;
-/**
- * microCMS createClient params
- */
-export interface MicroCMSClient {
-    serviceDomain: string;
-    apiKey: string;
-    customFetch?: Fetch;
-    retry?: boolean;
-}
-declare type depthNumber = 1 | 2 | 3;
-/**
- * microCMS queries
- * https://document.microcms.io/content-api/get-list-contents#h9ce528688c
- * https://document.microcms.io/content-api/get-content#h9ce528688c
- */
-export interface MicroCMSQueries {
-    draftKey?: string;
-    limit?: number;
-    offset?: number;
-    orders?: string;
-    fields?: string | string[];
-    q?: string;
-    depth?: depthNumber;
-    ids?: string | string[];
-    filters?: string;
-    richEditorFormat?: 'html' | 'object';
-}
-/**
- * microCMS contentId
- * https://document.microcms.io/manual/content-id-setting
- */
-export interface MicroCMSContentId {
-    id: string;
-}
-/**
- * microCMS content common date
- */
-export interface MicroCMSDate {
-    createdAt: string;
-    updatedAt: string;
-    publishedAt?: string;
-    revisedAt?: string;
-}
-/**
- * microCMS image
- */
-export interface MicroCMSImage {
-    url: string;
-    width?: number;
-    height?: number;
-}
-/**
- * microCMS list api Response
- */
-export interface MicroCMSListResponse<T> {
-    contents: (T & MicroCMSListContent)[];
-    totalCount: number;
-    limit: number;
-    offset: number;
-}
-/**
- * microCMS list content common types
- */
-export declare type MicroCMSListContent = MicroCMSContentId & MicroCMSDate;
-/**
- * microCMS object content common types
- */
-export declare type MicroCMSObjectContent = MicroCMSDate;
-export interface MakeRequest {
-    endpoint: string;
-    contentId?: string;
-    queries?: MicroCMSQueries & Record<string, any>;
-    requestInit?: RequestInit;
-}
-export declare type CustomRequestInit = Omit<RequestInit, 'method' | 'headers' | 'body'>;
-export interface GetRequest {
-    endpoint: string;
-    contentId?: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetListDetailRequest {
-    endpoint: string;
-    contentId: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetListRequest {
-    endpoint: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetObjectRequest {
-    endpoint: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface WriteApiRequestResult {
-    id: string;
-}
-export interface CreateRequest<T> {
-    endpoint: string;
-    contentId?: string;
-    content: T;
-    isDraft?: boolean;
-    customRequestInit?: CustomRequestInit;
-}
-export interface UpdateRequest<T> {
-    endpoint: string;
-    contentId?: string;
-    content: Partial<T>;
-    customRequestInit?: CustomRequestInit;
-}
-export interface DeleteRequest {
-    endpoint: string;
-    contentId: string;
-    customRequestInit?: CustomRequestInit;
-}
-export {};

package/dist/esm/utils/constants.d.ts

@@ -1,4 +0,0 @@
-export declare const BASE_DOMAIN = "microcms.io";
-export declare const API_VERSION = "v1";
-export declare const MAX_RETRY_COUNT = 2;
-export declare const MIN_TIMEOUT_MS = 5000;

package/dist/esm/utils/isCheckValue.d.ts

@@ -1,14 +0,0 @@
-/**
- * Check object
- *
- * @param {unknown} value
- * @returns {boolean}
- */
-export declare const isObject: (value: unknown) => value is Record<string, unknown>;
-/**
- * Check string
- *
- * @param {unknown} value
- * @returns {boolean}
- */
-export declare const isString: (value: unknown) => value is string;

package/dist/esm/utils/parseQuery.d.ts

@@ -1,2 +0,0 @@
-import { MicroCMSQueries } from '../types';
-export declare const parseQuery: (queries: MicroCMSQueries) => string;

package/dist/umd/createClient.d.ts

@@ -1,13 +0,0 @@
-import { MicroCMSClient, GetRequest, GetListRequest, GetListDetailRequest, GetObjectRequest, WriteApiRequestResult, CreateRequest, MicroCMSListResponse, MicroCMSListContent, MicroCMSObjectContent, UpdateRequest, DeleteRequest } from './types';
-/**
- * Initialize SDK Client
- */
-export declare const createClient: ({ serviceDomain, apiKey, customFetch, retry: retryOption, }: MicroCMSClient) => {
-    get: <T = any>({ endpoint, contentId, queries, customRequestInit, }: GetRequest) => Promise<T>;
-    getList: <T_1 = any>({ endpoint, queries, customRequestInit, }: GetListRequest) => Promise<MicroCMSListResponse<T_1>>;
-    getListDetail: <T_2 = any>({ endpoint, contentId, queries, customRequestInit, }: GetListDetailRequest) => Promise<T_2 & import("./types").MicroCMSContentId & import("./types").MicroCMSDate>;
-    getObject: <T_3 = any>({ endpoint, queries, customRequestInit, }: GetObjectRequest) => Promise<T_3 & import("./types").MicroCMSDate>;
-    create: <T_4 extends Record<string | number, any>>({ endpoint, contentId, content, isDraft, customRequestInit, }: CreateRequest<T_4>) => Promise<WriteApiRequestResult>;
-    update: <T_5 extends Record<string | number, any>>({ endpoint, contentId, content, customRequestInit, }: UpdateRequest<T_5>) => Promise<WriteApiRequestResult>;
-    delete: ({ endpoint, contentId, customRequestInit, }: DeleteRequest) => Promise<void>;
-};

package/dist/umd/index.d.ts

@@ -1,2 +0,0 @@
-export { createClient } from './createClient';
-export * from './types';

package/dist/umd/lib/fetch.d.ts

@@ -1,7 +0,0 @@
-import { Fetch } from 'src/types';
-export declare const resolveFetch: (customFetch?: Fetch) => Fetch;
-export declare const resolveHeadersConstructor: () => {
-    new (init?: HeadersInit | undefined): Headers;
-    prototype: Headers;
-};
-export declare const generateFetchClient: (apiKey: string, customFetch?: Fetch) => Fetch;

package/dist/umd/types.d.ts

@@ -1,120 +0,0 @@
-export declare type Fetch = typeof fetch;
-/**
- * microCMS createClient params
- */
-export interface MicroCMSClient {
-    serviceDomain: string;
-    apiKey: string;
-    customFetch?: Fetch;
-    retry?: boolean;
-}
-declare type depthNumber = 1 | 2 | 3;
-/**
- * microCMS queries
- * https://document.microcms.io/content-api/get-list-contents#h9ce528688c
- * https://document.microcms.io/content-api/get-content#h9ce528688c
- */
-export interface MicroCMSQueries {
-    draftKey?: string;
-    limit?: number;
-    offset?: number;
-    orders?: string;
-    fields?: string | string[];
-    q?: string;
-    depth?: depthNumber;
-    ids?: string | string[];
-    filters?: string;
-    richEditorFormat?: 'html' | 'object';
-}
-/**
- * microCMS contentId
- * https://document.microcms.io/manual/content-id-setting
- */
-export interface MicroCMSContentId {
-    id: string;
-}
-/**
- * microCMS content common date
- */
-export interface MicroCMSDate {
-    createdAt: string;
-    updatedAt: string;
-    publishedAt?: string;
-    revisedAt?: string;
-}
-/**
- * microCMS image
- */
-export interface MicroCMSImage {
-    url: string;
-    width?: number;
-    height?: number;
-}
-/**
- * microCMS list api Response
- */
-export interface MicroCMSListResponse<T> {
-    contents: (T & MicroCMSListContent)[];
-    totalCount: number;
-    limit: number;
-    offset: number;
-}
-/**
- * microCMS list content common types
- */
-export declare type MicroCMSListContent = MicroCMSContentId & MicroCMSDate;
-/**
- * microCMS object content common types
- */
-export declare type MicroCMSObjectContent = MicroCMSDate;
-export interface MakeRequest {
-    endpoint: string;
-    contentId?: string;
-    queries?: MicroCMSQueries & Record<string, any>;
-    requestInit?: RequestInit;
-}
-export declare type CustomRequestInit = Omit<RequestInit, 'method' | 'headers' | 'body'>;
-export interface GetRequest {
-    endpoint: string;
-    contentId?: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetListDetailRequest {
-    endpoint: string;
-    contentId: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetListRequest {
-    endpoint: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface GetObjectRequest {
-    endpoint: string;
-    queries?: MicroCMSQueries;
-    customRequestInit?: CustomRequestInit;
-}
-export interface WriteApiRequestResult {
-    id: string;
-}
-export interface CreateRequest<T> {
-    endpoint: string;
-    contentId?: string;
-    content: T;
-    isDraft?: boolean;
-    customRequestInit?: CustomRequestInit;
-}
-export interface UpdateRequest<T> {
-    endpoint: string;
-    contentId?: string;
-    content: Partial<T>;
-    customRequestInit?: CustomRequestInit;
-}
-export interface DeleteRequest {
-    endpoint: string;
-    contentId: string;
-    customRequestInit?: CustomRequestInit;
-}
-export {};

package/dist/umd/utils/constants.d.ts

@@ -1,4 +0,0 @@
-export declare const BASE_DOMAIN = "microcms.io";
-export declare const API_VERSION = "v1";
-export declare const MAX_RETRY_COUNT = 2;
-export declare const MIN_TIMEOUT_MS = 5000;

package/dist/umd/utils/isCheckValue.d.ts

@@ -1,14 +0,0 @@
-/**
- * Check object
- *
- * @param {unknown} value
- * @returns {boolean}
- */
-export declare const isObject: (value: unknown) => value is Record<string, unknown>;
-/**
- * Check string
- *
- * @param {unknown} value
- * @returns {boolean}
- */
-export declare const isString: (value: unknown) => value is string;

package/dist/umd/utils/parseQuery.d.ts

@@ -1,2 +0,0 @@
-import { MicroCMSQueries } from '../types';
-export declare const parseQuery: (queries: MicroCMSQueries) => string;