@epcc-sdk/sdks-files 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Elastic Path Software Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,220 @@
+# @epcc-sdk/sdks-files SDK
+
+Below you’ll find instructions on how to install, set up, and use the client, along with a list of available operations.
+
+## Features
+
+- type-safe response data and errors
+- response data validation and transformation
+- access to the original request and response
+- granular request and response customization options
+- minimal learning curve thanks to extending the underlying technology
+
+---
+
+## Installation
+
+```bash
+npm install @epcc-sdk/sdks-files
+# or
+pnpm install @epcc-sdk/sdks-files
+# or
+yarn add @epcc-sdk/sdks-files
+```
+
+---
+
+## Client Usage
+
+
+Clients are responsible for sending the actual HTTP requests.
+
+The Fetch client is built as a thin wrapper on top of Fetch API, extending its functionality. If you're already familiar with Fetch, configuring your client will feel like working directly with Fetch API.
+
+You can configure the client in two ways:
+
+- Configuring the internal `client` instance directly
+- Using the `createClient` function
+
+**When using the operation function to make requests, by default the global client will be used unless another is provided.**
+
+
+### 1. Configure the internal `client` instance directly
+
+This is the simpler approach. You can call the setConfig() method at the beginning of your application or anytime you need to update the client configuration. You can pass any Fetch API configuration option to setConfig(), and even your own Fetch implementation.
+
+```ts
+import { client } from "@epcc-sdk/sdks-files";
+
+client.setConfig({
+// set default base url for requests
+baseUrl: 'https://euwest.api.elasticpath.com',
+
+// set default headers for requests
+headers: {
+Authorization: 'Bearer YOUR_AUTH_TOKEN',
+},
+});
+```
+
+The disadvantage of this approach is that your code may call the client instance before it's configured for the first time. Depending on your use case, you might need to use the second approach.
+
+### 2. Using the `createClient` function
+
+This is useful when you want to use a different instance of the client for different parts of your application or when you want to use different configurations for different parts of your application.
+
+```ts
+import { createClient } from "@epcc-sdk/sdks-files";
+
+// Create the client with your API base URL.
+const client = createClient({
+    // set default base url for requests
+    baseUrl: "https://euwest.api.elasticpath.com",
+    /**
+    * Set default headers only for requests made by this client.
+    */
+    headers: {
+        "Custom-Header": 'My Value',
+    },
+});
+```
+
+You can also pass this instance to any SDK function through the client option. This will override the default instance from `import { client } from "@epcc-sdk/sdks-files>".
+
+```ts
+const response = await getAFile({
+    client: myClient,
+});
+```
+
+### Direct configuration
+
+Alternatively, you can pass the client configuration options to each SDK function. This is useful if you don't want to create a client instance for one-off use cases.
+
+```ts
+const response = await getAFile({
+    baseUrl: 'https://example.com', // <-- override default configuration
+});
+```
+
+## Interceptors (Middleware)
+
+Interceptors (middleware) can be used to modify requests before they're sent or responses before they're returned to your application. They can be added with use and removed with eject. Below is an example request interceptor
+
+```ts
+import { client } from "@epcc-sdk/sdks-files";
+
+// Supports async functions
+client.interceptors.request.use(async (request) => {
+    // do something
+    return request;
+});
+
+client.interceptors.request.eject((request) => {
+    // do something
+    return request;
+});
+
+```
+
+and an example response interceptor
+
+```ts
+import { client } from "@epcc-sdk/sdks-files";
+
+client.interceptors.response.use((response) => {
+    // do something
+    return response;
+});
+
+client.interceptors.response.eject((response) => {
+    // do something
+    return response;
+});
+```
+
+> **_Tip:_** To eject, you must provide a reference to the function that was passed to use().
+
+## Authentication
+
+We are working to provide helpers to handle auth easier for you but for now using an interceptor is the easiest method.
+
+```ts
+import { client } from "@epcc-sdk/sdks-files";
+
+client.interceptors.request.use((request, options) => {
+  request.headers.set('Authorization', 'Bearer MY_TOKEN');
+  return request;
+});
+```
+
+## Build URL
+
+If you need to access the compiled URL, you can use the buildUrl() method. It's loosely typed by default to accept almost any value; in practice, you will want to pass a type hint.
+
+```ts
+type FooData = {
+  path: {
+    fooId: number;
+  };
+  query?: {
+    bar?: string;
+  };
+  url: '/foo/{fooId}';
+};
+
+const url = client.buildUrl<FooData>({
+  path: {
+    fooId: 1,
+  },
+  query: {
+    bar: 'baz',
+  },
+  url: '/foo/{fooId}',
+});
+console.log(url); // prints '/foo/1?bar=baz'
+```
+
+
+---
+
+
+
+
+
+## Operation Usage
+The following examples demonstrate how to use the operation function to make requests.
+
+```ts
+import { getAFile } from "@epcc-sdk/sdks-files";
+
+const product = await getAFile({
+  // client: localClient, // optional if you have a client instance you want to use otherwise the global client will be used
+  path: {
+    ...
+  },
+  query: {
+    ...
+  },
+});
+```
+
+---
+
+
+
+## Available Operations
+
+
+
+- **`getAllFiles`** (`GET /v2/files`)
+
+- **`createAFile`** (`POST /v2/files`)
+
+- **`deleteAFile`** (`DELETE /v2/files/{fileID}`)
+
+- **`getAFile`** (`GET /v2/files/{fileID}`)
+
+
+
+---

package/dist/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types.gen";
+export * from "./sdk.gen";

package/dist/client/index.js

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from "./types.gen";
+export * from "./sdk.gen";

package/dist/client/sdk.gen.d.ts

@@ -0,0 +1,45 @@
+import { type Options } from "@hey-api/client-fetch";
+import type { GetAllFilesData, CreateAFileData, DeleteAFileData, GetAFileData } from "./types.gen";
+export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
+/**
+ * Get all Files
+ * Retrieves all files.
+ *
+ * ### Filtering
+ *
+ * For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering).
+ *
+ * The following operators and attributes are available when filtering on this endpoint.
+ *
+ * | Attribute             | Type      | Operators           | Example |
+ * |:----------------------|:----------|:--------------------------|:-------------|
+ * | `file_name`           | `string`  | `eq` / `like`             | `eq(file_name, my_image.jpg)` |
+ * | `width`               | `integer` | `gt` / `ge` / `lt` / `le` | `gt(width,200)` |
+ * | `height`              | `integer` | `gt` / `ge` / `lt` / `le` | `lt(height,500)` |
+ * | `file_size`           | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |
+ *
+ */
+export declare const getAllFiles: <ThrowOnError extends boolean = false>(options?: Options<GetAllFilesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    data?: Array<import("./types.gen").File>;
+    meta?: import("./types.gen").ResultsMeta;
+    links?: import("./types.gen").ResultsLinks;
+}, import("./types.gen").ErrorResponse, ThrowOnError>;
+/**
+ * Create a File
+ * Create a File
+ */
+export declare const createAFile: <ThrowOnError extends boolean = false>(options: Options<CreateAFileData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    data?: import("./types.gen").File;
+}, import("./types.gen").ErrorResponse, ThrowOnError>;
+/**
+ * Delete a File
+ * Delete a File
+ */
+export declare const deleteAFile: <ThrowOnError extends boolean = false>(options: Options<DeleteAFileData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").ErrorResponse, ThrowOnError>;
+/**
+ * Get a File
+ * Get a File
+ */
+export declare const getAFile: <ThrowOnError extends boolean = false>(options: Options<GetAFileData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    data?: import("./types.gen").File;
+}, import("./types.gen").ErrorResponse, ThrowOnError>;

package/dist/client/sdk.gen.js

@@ -0,0 +1,80 @@
+// This file is auto-generated by @hey-api/openapi-ts
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { createClient, createConfig, formDataBodySerializer, } from "@hey-api/client-fetch";
+export var client = createClient(createConfig());
+/**
+ * Get all Files
+ * Retrieves all files.
+ *
+ * ### Filtering
+ *
+ * For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering).
+ *
+ * The following operators and attributes are available when filtering on this endpoint.
+ *
+ * | Attribute             | Type      | Operators           | Example |
+ * |:----------------------|:----------|:--------------------------|:-------------|
+ * | `file_name`           | `string`  | `eq` / `like`             | `eq(file_name, my_image.jpg)` |
+ * | `width`               | `integer` | `gt` / `ge` / `lt` / `le` | `gt(width,200)` |
+ * | `height`              | `integer` | `gt` / `ge` / `lt` / `le` | `lt(height,500)` |
+ * | `file_size`           | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |
+ *
+ */
+export var getAllFiles = function (options) {
+    var _a;
+    return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
+            {
+                scheme: "bearer",
+                type: "http",
+            },
+        ], url: "/v2/files" }));
+};
+/**
+ * Create a File
+ * Create a File
+ */
+export var createAFile = function (options) {
+    var _a;
+    return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).post(__assign(__assign(__assign({}, options), formDataBodySerializer), { headers: __assign({ "Content-Type": null }, options === null || options === void 0 ? void 0 : options.headers), security: [
+            {
+                scheme: "bearer",
+                type: "http",
+            },
+        ], url: "/v2/files" }));
+};
+/**
+ * Delete a File
+ * Delete a File
+ */
+export var deleteAFile = function (options) {
+    var _a;
+    return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).delete(__assign(__assign({}, options), { security: [
+            {
+                scheme: "bearer",
+                type: "http",
+            },
+        ], url: "/v2/files/{fileID}" }));
+};
+/**
+ * Get a File
+ * Get a File
+ */
+export var getAFile = function (options) {
+    var _a;
+    return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client).get(__assign(__assign({}, options), { security: [
+            {
+                scheme: "bearer",
+                type: "http",
+            },
+        ], url: "/v2/files/{fileID}" }));
+};

package/dist/client/types.gen.d.ts

@@ -0,0 +1,301 @@
+export type ErrorResponse = {
+    errors: Array<_Error>;
+};
+export type File = {
+    /**
+     * The unique identifier for this file.
+     */
+    id?: Uuid;
+    /**
+     * The type represents the object being returned.
+     */
+    type?: string;
+    /**
+     * The name of the file.
+     */
+    file_name?: string;
+    /**
+     * The mime type of the file.
+     */
+    mime_type?: string;
+    /**
+     * The size of the file. Required when uploading files.
+     */
+    file_size?: number;
+    /**
+     * DEPRECATED Whether the file public or not. Required when uploading files.
+     */
+    public?: boolean;
+    meta?: FileMeta;
+    links?: Links;
+    link?: FileLink;
+};
+export type FileMeta = {
+    /**
+     * The date and time the file was created.
+     */
+    timestamps?: {
+        /**
+         * The date and time the file was created.
+         */
+        created_at?: string;
+    };
+    /**
+     * The file dimensions.
+     */
+    dimensions?: {
+        /**
+         * The width of the file.
+         */
+        width?: number;
+        /**
+         * The height of the file.
+         */
+        height?: number;
+    };
+};
+export type ResultsMeta = {
+    /**
+     * Contains the results for the entire collection.
+     */
+    page?: {
+        /**
+         * The maximum number of records for all pages.
+         */
+        limit?: number;
+        /**
+         * The current offset by number of pages.
+         */
+        offset?: number;
+        /**
+         * The current number of pages.
+         */
+        current?: number;
+        /**
+         * The total number of records for the entire collection.
+         */
+        total?: number;
+    };
+    /**
+     * Contains the results for the entire collection.
+     */
+    results?: {
+        /**
+         * The total number of records for the entire collection.
+         */
+        total?: number;
+    };
+};
+/**
+ * Links are used to allow you to move between requests.
+ */
+export type Links = {
+    /**
+     * Single entities use a self parameter with a link to that specific resource.
+     */
+    self?: string;
+};
+/**
+ * Links are used to allow you to move between requests.
+ */
+export type ResultsLinks = {
+    /**
+     * Single entities use a self parameter with a link to that specific resource.
+     */
+    self?: string | null;
+    /**
+     * Always the first page.
+     */
+    first?: string | null;
+    /**
+     * This is `null` if there is only one page.
+     */
+    last?: string | null;
+};
+/**
+ * The publicly available URL for this file.
+ */
+export type FileLink = {
+    /**
+     * The publicly available URL for this file.
+     */
+    href?: string;
+};
+export type Uuid = string;
+export type _Error = {
+    /**
+     * The HTTP response code of the error.
+     */
+    status: number;
+    /**
+     * A brief summary of the error.
+     */
+    title: string;
+    /**
+     * Optional additional detail about the error.
+     */
+    detail?: string;
+    /**
+     * Internal request ID.
+     */
+    request_id?: string;
+    /**
+     * Additional supporting meta data for the error.
+     */
+    meta?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ *
+ * Filtering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).
+ *
+ */
+export type Filter = string;
+/**
+ * The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
+ */
+export type PageOffset = string;
+/**
+ * The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
+ */
+export type PageLimit = string;
+export type GetAllFilesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         *
+         * Filtering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).
+         *
+         */
+        filter?: string;
+        /**
+         * The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
+         */
+        "page[limit]"?: string;
+        /**
+         * The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
+         */
+        "page[offset]"?: string;
+    };
+    url: "/v2/files";
+};
+export type GetAllFilesErrors = {
+    /**
+     * Internal server error. There was a system failure in the platform.
+     */
+    500: ErrorResponse;
+};
+export type GetAllFilesError = GetAllFilesErrors[keyof GetAllFilesErrors];
+export type GetAllFilesResponses = {
+    /**
+     * OK
+     */
+    200: {
+        data?: Array<File>;
+        meta?: ResultsMeta;
+        links?: ResultsLinks;
+    };
+};
+export type GetAllFilesResponse = GetAllFilesResponses[keyof GetAllFilesResponses];
+export type CreateAFileData = {
+    body: {
+        /**
+         * Indicates the file you want to upload.
+         */
+        file?: Blob | File;
+        /**
+         * Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.
+         */
+        file_location?: string;
+    };
+    path?: never;
+    query?: never;
+    url: "/v2/files";
+};
+export type CreateAFileErrors = {
+    /**
+     * Bad request. The request failed validation.
+     */
+    400: ErrorResponse;
+    /**
+     * Bad request. The request failed validation.
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error. There was a system failure in the platform.
+     */
+    500: ErrorResponse;
+};
+export type CreateAFileError = CreateAFileErrors[keyof CreateAFileErrors];
+export type CreateAFileResponses = {
+    /**
+     * Created
+     */
+    201: {
+        data?: File;
+    };
+};
+export type CreateAFileResponse = CreateAFileResponses[keyof CreateAFileResponses];
+export type DeleteAFileData = {
+    body?: never;
+    path: {
+        /**
+         * The unique identifier of the file you want to delete.
+         */
+        fileID: string;
+    };
+    query?: never;
+    url: "/v2/files/{fileID}";
+};
+export type DeleteAFileErrors = {
+    /**
+     * Bad request. The request failed validation.
+     */
+    403: ErrorResponse;
+    /**
+     * Forbidden. The operation is forbidden on this entity.
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error. There was a system failure in the platform.
+     */
+    500: ErrorResponse;
+};
+export type DeleteAFileError = DeleteAFileErrors[keyof DeleteAFileErrors];
+export type DeleteAFileResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteAFileResponse = DeleteAFileResponses[keyof DeleteAFileResponses];
+export type GetAFileData = {
+    body?: never;
+    path: {
+        /**
+         * The unique identifier for a file.
+         */
+        fileID: string;
+    };
+    query?: never;
+    url: "/v2/files/{fileID}";
+};
+export type GetAFileErrors = {
+    /**
+     * Forbidden. The operation is forbidden on this entity.
+     */
+    404: ErrorResponse;
+    /**
+     * Internal server error. There was a system failure in the platform.
+     */
+    500: ErrorResponse;
+};
+export type GetAFileError = GetAFileErrors[keyof GetAFileErrors];
+export type GetAFileResponses = {
+    200: {
+        data?: File;
+    };
+};
+export type GetAFileResponse = GetAFileResponses[keyof GetAFileResponses];

package/dist/client/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./client";
+import { Client, createClient } from "@hey-api/client-fetch";
+export { createClient, Client };
+export { client } from "./client/sdk.gen";

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./client";
+import { createClient } from "@hey-api/client-fetch";
+export { createClient };
+export { client } from "./client/sdk.gen";

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@epcc-sdk/sdks-files",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "node": {
+        "import": "./dist/index.js",
+        "require": "./dist/index.js"
+      },
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "keywords": [],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "0.61.2",
+    "typescript": "^5.5.3",
+    "@types/ejs": "^3.1.5",
+    "ejs": "^3.1.10"
+  },
+  "dependencies": {
+    "@hey-api/client-fetch": "0.6.0"
+  },
+  "scripts": {
+    "build": "pnpm openapi-ts && pnpm tsc:build",
+    "tsc:build": "tsc -p tsconfig.node.json",
+    "openapi-ts": "openapi-ts"
+  }
+}