@scaleway/sdk-search 1.1.0

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-search
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-search.svg)](https://www.npmjs.com/package/@scaleway/sdk-search)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-search.svg)](https://www.npmjs.com/package/@scaleway/sdk-search)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-search.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Search 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-search @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-search @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-search @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 { Search } from '@scaleway/sdk-search'
+
+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 Search.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 { Search } from '@scaleway/sdk-search'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Search.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Search API Documentation](https://www.scaleway.com/en/developers/api/search/)
+- 📖 [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/.vite/license.md

@@ -0,0 +1,3 @@
+# Licenses
+
+The app does not bundle any dependencies with licenses.

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll };

package/dist/index.gen.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file is automatically generated
+ * PLEASE DO NOT EDIT HERE
+ */
+export * as Searchv1alpha1 from './v1alpha1/index.gen.js';

package/dist/index.gen.js

@@ -0,0 +1,2 @@
+import { index_gen_exports } from "./v1alpha1/index.gen.js";
+export { index_gen_exports as Searchv1alpha1 };

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

@@ -0,0 +1,14 @@
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { SearchResourcesRequest, SearchResourcesResponse } from './types.gen.js';
+/**
+ * Search API.
+ */
+export declare class API extends ParentAPI {
+    /**
+     * Search API.
+     *
+     * @param request - The request {@link SearchResourcesRequest}
+     * @returns A Promise of SearchResourcesResponse
+     */
+    searchResources: (request: Readonly<SearchResourcesRequest>) => Promise<SearchResourcesResponse>;
+}

package/dist/v1alpha1/api.gen.js

@@ -0,0 +1,18 @@
+import { unmarshalSearchResourcesResponse } from "./marshalling.gen.js";
+import { API as API$1, urlParams } from "@scaleway/sdk-client";
+//#region src/v1alpha1/api.gen.ts
+/**
+* Search API.
+*/
+var API = class extends API$1 {
+	constructor(..._args) {
+		super(..._args);
+		this.searchResources = (request) => this.client.fetch({
+			method: "GET",
+			path: `/search/v1alpha1/resources`,
+			urlParams: urlParams(["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId], ["query", request.query])
+		}, unmarshalSearchResourcesResponse);
+	}
+};
+//#endregion
+export { API };

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

@@ -0,0 +1,4 @@
+export { API, } from './api.gen.js';
+export * from './marshalling.gen.js';
+export type { BrmServerInfo, Resource, ResourceType, SearchResourcesRequest, SearchResourcesResponse, ServerlessContainersContainerInfo, ServerlessFunctionsFunctionInfo, ServerlessSqldbBackupInfo, VpcPrivateNetworkInfo, } from './types.gen.js';
+export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1alpha1/index.gen.js

@@ -0,0 +1,12 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
+import { unmarshalSearchResourcesResponse } from "./marshalling.gen.js";
+import { API } from "./api.gen.js";
+import { validation_rules_gen_exports } from "./validation-rules.gen.js";
+//#region src/v1alpha1/index.gen.ts
+var index_gen_exports = /* @__PURE__ */ __exportAll({
+	API: () => API,
+	ValidationRules: () => validation_rules_gen_exports,
+	unmarshalSearchResourcesResponse: () => unmarshalSearchResourcesResponse
+});
+//#endregion
+export { API, validation_rules_gen_exports as ValidationRules, index_gen_exports, unmarshalSearchResourcesResponse };

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

@@ -0,0 +1,2 @@
+import type { SearchResourcesResponse } from './types.gen.js';
+export declare const unmarshalSearchResourcesResponse: (data: unknown) => SearchResourcesResponse;

package/dist/v1alpha1/marshalling.gen.js

@@ -0,0 +1,46 @@
+import { isJSONObject, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+//#region src/v1alpha1/marshalling.gen.ts
+const unmarshalBrmServerInfo = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'BrmServerInfo' failed as data isn't a dictionary.`);
+	return { ip: data.ip };
+};
+const unmarshalServerlessContainersContainerInfo = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ServerlessContainersContainerInfo' failed as data isn't a dictionary.`);
+	return { namespaceId: data.namespace_id };
+};
+const unmarshalServerlessFunctionsFunctionInfo = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ServerlessFunctionsFunctionInfo' failed as data isn't a dictionary.`);
+	return { namespaceId: data.namespace_id };
+};
+const unmarshalServerlessSqldbBackupInfo = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ServerlessSqldbBackupInfo' failed as data isn't a dictionary.`);
+	return { databaseId: data.database_id };
+};
+const unmarshalVpcPrivateNetworkInfo = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'VpcPrivateNetworkInfo' failed as data isn't a dictionary.`);
+	return { vpcId: data.vpc_id };
+};
+const unmarshalResource = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Resource' failed as data isn't a dictionary.`);
+	return {
+		baremetalServerInfo: data.baremetal_server_info ? unmarshalBrmServerInfo(data.baremetal_server_info) : void 0,
+		global: data.global,
+		id: data.id,
+		name: data.name,
+		organizationId: data.organization_id,
+		projectId: data.project_id,
+		region: data.region,
+		serverlessContainersContainerInfo: data.serverless_containers_container_info ? unmarshalServerlessContainersContainerInfo(data.serverless_containers_container_info) : void 0,
+		serverlessFunctionsFunctionInfo: data.serverless_functions_function_info ? unmarshalServerlessFunctionsFunctionInfo(data.serverless_functions_function_info) : void 0,
+		serverlessSqldbBackupInfo: data.serverless_sqldb_backup_info ? unmarshalServerlessSqldbBackupInfo(data.serverless_sqldb_backup_info) : void 0,
+		type: data.type,
+		vpcPrivateNetworkInfo: data.vpc_private_network_info ? unmarshalVpcPrivateNetworkInfo(data.vpc_private_network_info) : void 0,
+		zone: data.zone
+	};
+};
+const unmarshalSearchResourcesResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'SearchResourcesResponse' failed as data isn't a dictionary.`);
+	return { resources: unmarshalArrayOfObject(data.resources, unmarshalResource) };
+};
+//#endregion
+export { unmarshalSearchResourcesResponse };

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

@@ -0,0 +1,19 @@
+export declare const queriesMetadata: {
+    readonly namespace: 'search';
+    readonly version: 'v1alpha1';
+    readonly folderName: 'searchv1alpha1';
+    readonly services: readonly [{
+        readonly apiClass: 'API';
+        readonly methods: readonly [{
+            readonly methodName: 'searchResources';
+            readonly protoName: 'SearchResources';
+            readonly paramsType: 'SearchResourcesRequest';
+            readonly returnType: 'SearchResourcesResponse';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }];
+    }];
+};
+export type QueriesMetadata = typeof queriesMetadata;

package/dist/v1alpha1/metadata.gen.js

@@ -0,0 +1,21 @@
+//#region src/v1alpha1/metadata.gen.ts
+const queriesMetadata = {
+	namespace: "search",
+	version: "v1alpha1",
+	folderName: "searchv1alpha1",
+	services: [{
+		apiClass: "API",
+		methods: [{
+			methodName: "searchResources",
+			protoName: "SearchResources",
+			paramsType: "SearchResourcesRequest",
+			returnType: "SearchResourcesResponse",
+			isList: false,
+			paginationType: "none",
+			isPrivate: false,
+			description: "\""
+		}]
+	}]
+};
+//#endregion
+export { queriesMetadata };

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

@@ -0,0 +1,110 @@
+import type { Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client';
+export type ResourceType = 'unknown_type' | 'instance_server' | 'instance_volume' | 'instance_image' | 'instance_security_group' | 'k8s_cluster' | 'k8s_pool' | 'k8s_node' | 'domain_domain' | 'dns_zone' | 'vpc_private_network' | 'vpc_vpc' | 'vpg_gateway' | 'apple_silicon_server' | 'rdb_instance' | 'rdb_snapshot' | 'rdb_backup' | 'baremetal_server' | 'tem_domain' | 'lb_server' | 'serverless_functions_function' | 'serverless_containers_container' | 'wbh_hosting' | 'redis_cluster' | 'sm_secret' | 'kms_key' | 'edg_pipeline' | 'mnq_nats_account' | 'sbs_volume' | 'sbs_snapshot' | 'serverless_job_definition' | 'serverless_sqldb_database' | 'serverless_sqldb_backup' | 'ddl_datalab' | 'mgdb_instance' | 'mgdb_snapshot' | 'ifr_deployment' | 'ifr_model' | 'gapi_batch' | 'dtwh_deployment' | 'obs_datasource' | 'obs_token' | 'obs_alert' | 'svpn_vpn_gateway' | 'svpn_customer_gateway' | 'svpn_connection' | 'svpn_routing_policy';
+export interface BrmServerInfo {
+    ip: string;
+}
+export interface ServerlessContainersContainerInfo {
+    /**
+     * ID of the Namespace the Serverless Container belongs to.
+     */
+    namespaceId: string;
+}
+export interface ServerlessFunctionsFunctionInfo {
+    /**
+     * ID of the Namespace the Serverless Function belongs to.
+     */
+    namespaceId: string;
+}
+export interface ServerlessSqldbBackupInfo {
+    databaseId: string;
+}
+export interface VpcPrivateNetworkInfo {
+    /**
+     * ID of the VPC the Private Network belongs to.
+     */
+    vpcId: string;
+}
+export interface Resource {
+    /**
+     * ID of the resource.
+     */
+    id: string;
+    /**
+     * Name of the resource.
+     */
+    name?: string;
+    /**
+     * ID of the Project the resource belongs to.
+     */
+    projectId?: string;
+    /**
+     * ID of the Organization the resource belongs to.
+     */
+    organizationId: string;
+    /**
+     * Type of the resource.
+     */
+    type: ResourceType;
+    /**
+     * Locality the resource is in if this is a global resource.
+     *
+     * One-of ('locality'): at most one of 'global', 'zone', 'region' could be set.
+     */
+    global?: boolean;
+    /**
+     * Locality the resource is in if this is a zonal resource.
+     *
+     * One-of ('locality'): at most one of 'global', 'zone', 'region' could be set.
+     */
+    zone?: ScwZone;
+    /**
+     * Locality the resource is in if this is a regional resource.
+     *
+     * One-of ('locality'): at most one of 'global', 'zone', 'region' could be set.
+     */
+    region?: ScwRegion;
+    /**
+     * Additional information for a VPC Private Network.
+     *
+     * One-of ('info'): at most one of 'vpcPrivateNetworkInfo', 'serverlessFunctionsFunctionInfo', 'serverlessContainersContainerInfo', 'baremetalServerInfo', 'serverlessSqldbBackupInfo' could be set.
+     */
+    vpcPrivateNetworkInfo?: VpcPrivateNetworkInfo;
+    /**
+     * Additional information for a Serverless Function.
+     *
+     * One-of ('info'): at most one of 'vpcPrivateNetworkInfo', 'serverlessFunctionsFunctionInfo', 'serverlessContainersContainerInfo', 'baremetalServerInfo', 'serverlessSqldbBackupInfo' could be set.
+     */
+    serverlessFunctionsFunctionInfo?: ServerlessFunctionsFunctionInfo;
+    /**
+     * Additional information for a Serverless Container.
+     *
+     * One-of ('info'): at most one of 'vpcPrivateNetworkInfo', 'serverlessFunctionsFunctionInfo', 'serverlessContainersContainerInfo', 'baremetalServerInfo', 'serverlessSqldbBackupInfo' could be set.
+     */
+    serverlessContainersContainerInfo?: ServerlessContainersContainerInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'vpcPrivateNetworkInfo', 'serverlessFunctionsFunctionInfo', 'serverlessContainersContainerInfo', 'baremetalServerInfo', 'serverlessSqldbBackupInfo' could be set.
+     */
+    baremetalServerInfo?: BrmServerInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'vpcPrivateNetworkInfo', 'serverlessFunctionsFunctionInfo', 'serverlessContainersContainerInfo', 'baremetalServerInfo', 'serverlessSqldbBackupInfo' could be set.
+     */
+    serverlessSqldbBackupInfo?: ServerlessSqldbBackupInfo;
+}
+export type SearchResourcesRequest = {
+    /**
+     * Search query.
+     */
+    query: string;
+    /**
+     * ID of the Organization to search in.
+     */
+    organizationId?: string;
+};
+export interface SearchResourcesResponse {
+    /**
+     * Top resources found.
+     */
+    resources: Resource[];
+}

package/dist/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,6 @@
+export declare const SearchResourcesRequest: {
+    query: {
+        maxLength: number;
+        minLength: number;
+    };
+};

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

@@ -0,0 +1,9 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
+//#region src/v1alpha1/validation-rules.gen.ts
+var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({ SearchResourcesRequest: () => SearchResourcesRequest });
+const SearchResourcesRequest = { query: {
+	maxLength: 100,
+	minLength: 2
+} };
+//#endregion
+export { SearchResourcesRequest, validation_rules_gen_exports };

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@scaleway/sdk-search",
+  "version": "1.1.0",
+  "description": "Scaleway SDK search",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "directory": "packages_generated/search"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.gen.d.ts",
+      "default": "./dist/index.gen.js"
+    },
+    "./*": {
+      "types": "./dist/*/index.gen.d.ts",
+      "default": "./dist/*/index.gen.js"
+    },
+    "./metadata": {
+      "types": "./dist/metadata.gen.d.ts",
+      "default": "./dist/metadata.gen.js"
+    },
+    "./*/metadata": {
+      "types": "./dist/*/metadata.gen.d.ts",
+      "default": "./dist/*/metadata.gen.js"
+    }
+  },
+  "dependencies": {
+    "@scaleway/random-name": "5.1.4",
+    "@scaleway/sdk-std": "2.4.2"
+  },
+  "devDependencies": {
+    "@scaleway/sdk-client": "^2.4.0"
+  },
+  "peerDependencies": {
+    "@scaleway/sdk-client": "^2.4.0"
+  },
+  "engines": {
+    "node": ">=20.20.2"
+  },
+  "scripts": {
+    "package:check": "pnpm publint",
+    "typecheck": "tsgo --noEmit",
+    "type:generate": "tsgo --declaration -p tsconfig.build.json",
+    "build": "vite build --config vite.config.ts && pnpm run type:generate",
+    "build:profile": "npx vite-bundle-visualizer -c vite.config.ts"
+  }
+}