@scaleway/sdk-file 1.3.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-file
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-file.svg)](https://www.npmjs.com/package/@scaleway/sdk-file)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-file.svg)](https://www.npmjs.com/package/@scaleway/sdk-file)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-file.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for File API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-file @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-file @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-file @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { File } from '@scaleway/sdk-file'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new File.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { File } from '@scaleway/sdk-file'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new File.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway File API Documentation](https://www.scaleway.com/en/developers/api/file/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

package/dist/v1alpha1/api.gen.d.ts

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsResponse, UpdateFileSystemRequest } from './types.gen.js';
 /**
  * File Storage API.

package/dist/v1alpha1/api.gen.js

@@ -10,7 +10,9 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par"]
+    regions: [
+      "fr-par"
+    ]
   });
   /**
    * Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID.
@@ -33,9 +35,7 @@ class API extends API$1 {
    * @returns A Promise of FileSystem
    */
   waitForFileSystem = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !FILE_SYSTEM_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!FILE_SYSTEM_TRANSIENT_STATUSES.includes(res.status))),
     this.getFileSystem,
     request,
     options
@@ -49,10 +49,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["tags", request.tags]
       )
@@ -73,10 +70,7 @@ class API extends API$1 {
       urlParams: urlParams(
         ["filesystem_id", request.filesystemId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["resource_id", request.resourceId],
         ["resource_type", request.resourceType],
         ["zone", request.zone]
@@ -114,10 +108,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteFileSystemRequest}
    */
-  deleteFileSystem = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
-  });
+  deleteFileSystem = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/file/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${validatePathParam("filesystemId", request.filesystemId)}`
+    }
+  );
   /**
    * Update filesystem properties. Update the technical details of a filesystem, such as its name, tags or its new size.
    *

package/dist/v1alpha1/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 export type { Attachment, AttachmentResourceType, CreateFileSystemRequest, DeleteFileSystemRequest, FileSystem, FileSystemStatus, GetFileSystemRequest, ListAttachmentsRequest, ListAttachmentsResponse, ListFileSystemsRequest, ListFileSystemsRequestOrderBy, ListFileSystemsResponse, UpdateFileSystemRequest, } from './types.gen.js';

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-file",
-  "version": "1.3.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK file",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/file"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.2.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1alpha1/index.gen.cjs");
-exports.Filev1alpha1 = index_gen;

package/dist/v1alpha1/api.gen.cjs

@@ -1,141 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends sdkClient.API {
-  /**
-   * Locality of this API.
-   * type ∈ {'zone','region','global','unspecified'}
-   */
-  static LOCALITY = sdkClient.toApiLocality({
-    regions: ["fr-par"]
-  });
-  /**
-   * Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID.
-   *
-   * @param request - The request {@link GetFileSystemRequest}
-   * @returns A Promise of FileSystem
-   */
-  getFileSystem = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${sdkClient.validatePathParam("filesystemId", request.filesystemId)}`
-    },
-    marshalling_gen.unmarshalFileSystem
-  );
-  /**
-   * Waits for {@link FileSystem} to be in a final state.
-   *
-   * @param request - The request {@link GetFileSystemRequest}
-   * @param options - The waiting options
-   * @returns A Promise of FileSystem
-   */
-  waitForFileSystem = (request, options) => sdkClient.waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !content_gen.FILE_SYSTEM_TRANSIENT_STATUSES.includes(res.status)
-    )),
-    this.getFileSystem,
-    request,
-    options
-  );
-  pageOfListFileSystems = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`,
-      urlParams: sdkClient.urlParams(
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["tags", request.tags]
-      )
-    },
-    marshalling_gen.unmarshalListFileSystemsResponse
-  );
-  /**
-   * List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
-   *
-   * @param request - The request {@link ListFileSystemsRequest}
-   * @returns A Promise of ListFileSystemsResponse
-   */
-  listFileSystems = (request = {}) => sdkClient.enrichForPagination("filesystems", this.pageOfListFileSystems, request);
-  pageOfListAttachments = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/attachments`,
-      urlParams: sdkClient.urlParams(
-        ["filesystem_id", request.filesystemId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["resource_id", request.resourceId],
-        ["resource_type", request.resourceType],
-        ["zone", request.zone]
-      )
-    },
-    marshalling_gen.unmarshalListAttachmentsResponse
-  );
-  /**
-     * List filesystems attachments. List all existing attachments in a specified region.
-  By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
-     *
-     * @param request - The request {@link ListAttachmentsRequest}
-     * @returns A Promise of ListAttachmentsResponse
-     */
-  listAttachments = (request = {}) => sdkClient.enrichForPagination("attachments", this.pageOfListAttachments, request);
-  /**
-   * Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID.
-   *
-   * @param request - The request {@link CreateFileSystemRequest}
-   * @returns A Promise of FileSystem
-   */
-  createFileSystem = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateFileSystemRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems`
-    },
-    marshalling_gen.unmarshalFileSystem
-  );
-  /**
-   * Delete a detached filesystem. You must specify the `filesystem_id` of the filesystem you want to delete.
-   *
-   * @param request - The request {@link DeleteFileSystemRequest}
-   */
-  deleteFileSystem = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${sdkClient.validatePathParam("filesystemId", request.filesystemId)}`
-  });
-  /**
-   * Update filesystem properties. Update the technical details of a filesystem, such as its name, tags or its new size.
-   *
-   * @param request - The request {@link UpdateFileSystemRequest}
-   * @returns A Promise of FileSystem
-   */
-  updateFileSystem = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateFileSystemRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/file/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/filesystems/${sdkClient.validatePathParam("filesystemId", request.filesystemId)}`
-    },
-    marshalling_gen.unmarshalFileSystem
-  );
-}
-exports.API = API;

package/dist/v1alpha1/content.gen.cjs

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const FILE_SYSTEM_TRANSIENT_STATUSES = [
-  "creating",
-  "updating"
-];
-exports.FILE_SYSTEM_TRANSIENT_STATUSES = FILE_SYSTEM_TRANSIENT_STATUSES;

package/dist/v1alpha1/index.gen.cjs

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const validationRules_gen = require("./validation-rules.gen.cjs");
-exports.API = api_gen.API;
-exports.FILE_SYSTEM_TRANSIENT_STATUSES = content_gen.FILE_SYSTEM_TRANSIENT_STATUSES;
-exports.marshalCreateFileSystemRequest = marshalling_gen.marshalCreateFileSystemRequest;
-exports.marshalUpdateFileSystemRequest = marshalling_gen.marshalUpdateFileSystemRequest;
-exports.unmarshalFileSystem = marshalling_gen.unmarshalFileSystem;
-exports.unmarshalListAttachmentsResponse = marshalling_gen.unmarshalListAttachmentsResponse;
-exports.unmarshalListFileSystemsResponse = marshalling_gen.unmarshalListFileSystemsResponse;
-exports.ValidationRules = validationRules_gen;

package/dist/v1alpha1/marshalling.gen.cjs

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const unmarshalFileSystem = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'FileSystem' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    id: data.id,
-    name: data.name,
-    numberOfAttachments: data.number_of_attachments,
-    organizationId: data.organization_id,
-    projectId: data.project_id,
-    region: data.region,
-    size: data.size,
-    status: data.status,
-    tags: data.tags,
-    updatedAt: sdkClient.unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalAttachment = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Attachment' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    filesystemId: data.filesystem_id,
-    id: data.id,
-    resourceId: data.resource_id,
-    resourceType: data.resource_type,
-    zone: data.zone
-  };
-};
-const unmarshalListAttachmentsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListAttachmentsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    attachments: sdkClient.unmarshalArrayOfObject(data.attachments, unmarshalAttachment),
-    totalCount: data.total_count
-  };
-};
-const unmarshalListFileSystemsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListFileSystemsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    filesystems: sdkClient.unmarshalArrayOfObject(data.filesystems, unmarshalFileSystem),
-    totalCount: data.total_count
-  };
-};
-const marshalCreateFileSystemRequest = (request, defaults) => ({
-  name: request.name,
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  size: request.size,
-  tags: request.tags
-});
-const marshalUpdateFileSystemRequest = (request, defaults) => ({
-  name: request.name,
-  size: request.size,
-  tags: request.tags
-});
-exports.marshalCreateFileSystemRequest = marshalCreateFileSystemRequest;
-exports.marshalUpdateFileSystemRequest = marshalUpdateFileSystemRequest;
-exports.unmarshalFileSystem = unmarshalFileSystem;
-exports.unmarshalListAttachmentsResponse = unmarshalListAttachmentsResponse;
-exports.unmarshalListFileSystemsResponse = unmarshalListFileSystemsResponse;

package/dist/v1alpha1/validation-rules.gen.cjs

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const CreateFileSystemRequest = {
-  name: {
-    minLength: 1
-  },
-  size: {
-    greaterThan: 0
-  }
-};
-const ListAttachmentsRequest = {
-  page: {
-    greaterThan: 0
-  },
-  pageSize: {
-    greaterThan: 0,
-    lessThanOrEqual: 100
-  }
-};
-const ListFileSystemsRequest = {
-  page: {
-    greaterThan: 0
-  },
-  pageSize: {
-    greaterThan: 0,
-    lessThanOrEqual: 100
-  }
-};
-const UpdateFileSystemRequest = {
-  name: {
-    minLength: 1
-  },
-  size: {
-    greaterThan: 0
-  }
-};
-exports.CreateFileSystemRequest = CreateFileSystemRequest;
-exports.ListAttachmentsRequest = ListAttachmentsRequest;
-exports.ListFileSystemsRequest = ListFileSystemsRequest;
-exports.UpdateFileSystemRequest = UpdateFileSystemRequest;