@twin.org/blob-storage-connector-gcp 0.0.1-next.17 → 0.0.1-next.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,7 +34,6 @@ class GcpBlobStorageConnector {
34
34
  /**
35
35
  * Create a new instance of GcpBlobStorageConnector.
36
36
  * @param options The options for the connector.
37
- * @param options.config The configuration for the connector.
38
37
  */
39
38
  constructor(options) {
40
39
  core.Guards.object(this.CLASS_NAME, "options", options);
@@ -32,7 +32,6 @@ class GcpBlobStorageConnector {
32
32
  /**
33
33
  * Create a new instance of GcpBlobStorageConnector.
34
34
  * @param options The options for the connector.
35
- * @param options.config The configuration for the connector.
36
35
  */
37
36
  constructor(options) {
38
37
  Guards.object(this.CLASS_NAME, "options", options);
@@ -1,5 +1,5 @@
1
1
  import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
2
- import type { IGcpBlobStorageConnectorConfig } from "./models/IGcpBlobStorageConnectorConfig";
2
+ import type { IGcpBlobStorageConnectorConstructorOptions } from "./models/IGcpBlobStorageConnectorConstructorOptions";
3
3
  /**
4
4
  * Class for performing blob storage operations on GCP Storage.
5
5
  * See https://cloud.google.com/storage/docs/reference/libraries for more information.
@@ -16,11 +16,8 @@ export declare class GcpBlobStorageConnector implements IBlobStorageConnector {
16
16
  /**
17
17
  * Create a new instance of GcpBlobStorageConnector.
18
18
  * @param options The options for the connector.
19
- * @param options.config The configuration for the connector.
20
19
  */
21
- constructor(options: {
22
- config: IGcpBlobStorageConnectorConfig;
23
- });
20
+ constructor(options: IGcpBlobStorageConnectorConstructorOptions);
24
21
  /**
25
22
  * Bootstrap the component by creating and initializing any resources it needs.
26
23
  * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
@@ -1,2 +1,3 @@
1
1
  export * from "./gcpBlobStorageConnector";
2
2
  export * from "./models/IGcpBlobStorageConnectorConfig";
3
+ export * from "./models/IGcpBlobStorageConnectorConstructorOptions";
@@ -0,0 +1,10 @@
1
+ import type { IGcpBlobStorageConnectorConfig } from "./IGcpBlobStorageConnectorConfig";
2
+ /**
3
+ * Options for the GCP Blob Storage Connector constructor.
4
+ */
5
+ export interface IGcpBlobStorageConnectorConstructorOptions {
6
+ /**
7
+ * The configuration for the connector.
8
+ */
9
+ config: IGcpBlobStorageConnectorConfig;
10
+ }
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/blob-storage-connector-gcp - Changelog
2
2
 
3
- ## v0.0.1-next.17
3
+ ## v0.0.1-next.19
4
4
 
5
5
  - Initial Release
@@ -17,13 +17,11 @@ Create a new instance of GcpBlobStorageConnector.
17
17
 
18
18
  #### Parameters
19
19
 
20
- **options**
20
+ ##### options
21
21
 
22
- The options for the connector.
23
-
24
- • **options.config**: [`IGcpBlobStorageConnectorConfig`](../interfaces/IGcpBlobStorageConnectorConfig.md)
22
+ [`IGcpBlobStorageConnectorConstructorOptions`](../interfaces/IGcpBlobStorageConnectorConstructorOptions.md)
25
23
 
26
- The configuration for the connector.
24
+ The options for the connector.
27
25
 
28
26
  #### Returns
29
27
 
@@ -59,7 +57,9 @@ Bootstrap the component by creating and initializing any resources it needs.
59
57
 
60
58
  #### Parameters
61
59
 
62
- **nodeLoggingConnectorType?**: `string`
60
+ ##### nodeLoggingConnectorType?
61
+
62
+ `string`
63
63
 
64
64
  The node logging connector type, defaults to "node-logging".
65
65
 
@@ -83,7 +83,9 @@ Set the blob.
83
83
 
84
84
  #### Parameters
85
85
 
86
- **blob**: `Uint8Array`
86
+ ##### blob
87
+
88
+ `Uint8Array`
87
89
 
88
90
  The data for the blob.
89
91
 
@@ -107,7 +109,9 @@ Get the blob.
107
109
 
108
110
  #### Parameters
109
111
 
110
- **id**: `string`
112
+ ##### id
113
+
114
+ `string`
111
115
 
112
116
  The id of the blob to get in urn format.
113
117
 
@@ -131,7 +135,9 @@ Remove the blob.
131
135
 
132
136
  #### Parameters
133
137
 
134
- **id**: `string`
138
+ ##### id
139
+
140
+ `string`
135
141
 
136
142
  The id of the blob to remove in urn format.
137
143
 
@@ -7,3 +7,4 @@
7
7
  ## Interfaces
8
8
 
9
9
  - [IGcpBlobStorageConnectorConfig](interfaces/IGcpBlobStorageConnectorConfig.md)
10
+ - [IGcpBlobStorageConnectorConstructorOptions](interfaces/IGcpBlobStorageConnectorConstructorOptions.md)
@@ -0,0 +1,11 @@
1
+ # Interface: IGcpBlobStorageConnectorConstructorOptions
2
+
3
+ Options for the GCP Blob Storage Connector constructor.
4
+
5
+ ## Properties
6
+
7
+ ### config
8
+
9
+ > **config**: [`IGcpBlobStorageConnectorConfig`](IGcpBlobStorageConnectorConfig.md)
10
+
11
+ The configuration for the connector.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-connector-gcp",
3
- "version": "0.0.1-next.17",
3
+ "version": "0.0.1-next.19",
4
4
  "description": "Blob Storage connector implementation using Google Cloud Storage",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,8 +14,8 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@google-cloud/storage": "^7.14.0",
18
- "@twin.org/blob-storage-models": "0.0.1-next.17",
17
+ "@google-cloud/storage": "^7.15.0",
18
+ "@twin.org/blob-storage-models": "0.0.1-next.19",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/crypto": "next",
21
21
  "@twin.org/logging-models": "next",
@@ -27,9 +27,9 @@
27
27
  "types": "./dist/types/index.d.ts",
28
28
  "exports": {
29
29
  ".": {
30
+ "types": "./dist/types/index.d.ts",
30
31
  "require": "./dist/cjs/index.cjs",
31
- "import": "./dist/esm/index.mjs",
32
- "types": "./dist/types/index.d.ts"
32
+ "import": "./dist/esm/index.mjs"
33
33
  },
34
34
  "./locales/*.json": "./locales/*.json"
35
35
  },