You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "trim21 (via GitHub)" <gi...@apache.org> on 2024/12/27 06:55:41 UTC
[PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
trim21 opened a new pull request, #5465:
URL: https://github.com/apache/opendal/pull/5465
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
Closes #.
# Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
# What changes are included in this PR?
generate types for nodejs binding.
type of `Operator` is already generated so we will need a new `create_operator` to add our generated typing.
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
# Are there any user-facing changes?
Yes, new typed method `create_operator`.
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking-changes` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "trim21 (via GitHub)" <gi...@apache.org>.
trim21 commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898344471
##########
bindings/nodejs/index.js:
##########
@@ -137,6 +137,10 @@ Writer.prototype.createWriteStream = function (options) {
return new WriteStream(this, options)
}
+module.exports.create_operator = function (scheme, options) {
Review Comment:
we can't since type of `Operator` is also generated
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898349260
##########
bindings/nodejs/index.js:
##########
@@ -137,6 +137,10 @@ Writer.prototype.createWriteStream = function (options) {
return new WriteStream(this, options)
}
+module.exports.create_operator = function (scheme, options) {
Review Comment:
> any idea how? do you suggest to wrap all method of `Operator`?
It seems like a possible approach. I'm not sure if we can have multiple `constructors` on the Rust side; perhaps we could generate Rust code as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "trim21 (via GitHub)" <gi...@apache.org>.
trim21 commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898353328
##########
bindings/nodejs/index.js:
##########
@@ -137,6 +137,10 @@ Writer.prototype.createWriteStream = function (options) {
return new WriteStream(this, options)
}
+module.exports.create_operator = function (scheme, options) {
Review Comment:
It's getting messy...
I haven't start using nodejs binding yet, maybe I'll try this some days later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "trim21 (via GitHub)" <gi...@apache.org>.
trim21 closed pull request #5465: feat(bindings/nodejs): generate types and add typed create_operator method
URL: https://github.com/apache/opendal/pull/5465
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898347325
##########
bindings/nodejs/index.js:
##########
@@ -137,6 +137,10 @@ Writer.prototype.createWriteStream = function (options) {
return new WriteStream(this, options)
}
+module.exports.create_operator = function (scheme, options) {
Review Comment:
Then we need to design new APIs instead of adding another one. Maybe we can impelment `Operator` class in js instead of exposing from native binding?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "trim21 (via GitHub)" <gi...@apache.org>.
trim21 commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898347168
##########
bindings/nodejs/types.generated.d.ts:
##########
@@ -0,0 +1,584 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Operator } from './generated'
+
+export interface Aliyun_drive_Config {
+ root?: string
+ access_token?: string
+ client_id?: string
+ client_secret?: string
+ refresh_token?: string
+ drive_type: string
+}
+
+export interface Alluxio_Config {
+ root?: string
+ endpoint?: string
+}
+
+export interface Atomicserver_Config {
+ root?: string
+ endpoint?: string
+ private_key?: string
+ public_key?: string
+ parent_resource_id?: string
+}
+
+export interface Azblob_Config {
+ root?: string
+ container: string
+ endpoint?: string
+ account_name?: string
+ account_key?: string
+ encryption_key?: string
+ encryption_key_sha256?: string
+ encryption_algorithm?: string
+ sas_token?: string
+ batch_max_operations?: string
+}
+
+export interface Azdls_Config {
+ root?: string
+ filesystem: string
+ endpoint?: string
+ account_name?: string
+ account_key?: string
+}
+
+export interface Azfile_Config {
+ root?: string
+ endpoint?: string
+ share_name: string
+ account_name?: string
+ account_key?: string
+ sas_token?: string
+}
+
+export interface B2_Config {
+ root?: string
+ application_key_id?: string
+ application_key?: string
+ bucket: string
+ bucket_id: string
+}
+
+export interface Cacache_Config {
+ datadir?: string
+}
+
+export interface Chainsafe_Config {
+ root?: string
+ api_key?: string
+ bucket_id: string
+}
+
+export interface Cloudflare_kv_Config {
+ token?: string
+ account_id?: string
+ namespace_id?: string
+ root?: string
+}
+
+export interface Compfs_Config {
+ root?: string
+}
+
+export interface Cos_Config {
+ root?: string
+ endpoint?: string
+ secret_id?: string
+ secret_key?: string
+ bucket?: string
+ disable_config_load?: string
+}
+
+export interface D1_Config {
+ token?: string
+ account_id?: string
+ database_id?: string
+ root?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Dashmap_Config {
+ root?: string
+}
+
+export interface Dbfs_Config {
+ root?: string
+ endpoint?: string
+ token?: string
+}
+
+export interface Dropbox_Config {
+ root?: string
+ access_token?: string
+ refresh_token?: string
+ client_id?: string
+ client_secret?: string
+}
+
+export interface Fs_Config {
+ root?: string
+ atomic_write_dir?: string
+}
+
+export interface Gcs_Config {
+ root?: string
+ bucket: string
+ endpoint?: string
+ scope?: string
+ service_account?: string
+ credential?: string
+ credential_path?: string
+ predefined_acl?: string
+ default_storage_class?: string
+ allow_anonymous?: string
+ disable_vm_metadata?: string
+ disable_config_load?: string
+ token?: string
+}
+
+export interface Gdrive_Config {
+ root?: string
+ access_token?: string
+ refresh_token?: string
+ client_id?: string
+ client_secret?: string
+}
+
+export interface Ghac_Config {
+ root?: string
+ version?: string
+ endpoint?: string
+ runtime_token?: string
+}
+
+export interface Github_Config {
+ root?: string
+ token?: string
+ owner: string
+ repo: string
+}
+
+export interface Gridfs_Config {
+ connection_string?: string
+ database?: string
+ bucket?: string
+ chunk_size?: string
+ root?: string
+}
+
+export interface Hdfs_native_Config {
+ root?: string
+ url?: string
+ enable_append?: string
+}
+
+export interface Http_Config {
+ endpoint?: string
+ username?: string
+ password?: string
+ token?: string
+ root?: string
+}
+
+export interface Huggingface_Config {
+ repo_type?: string
+ repo_id?: string
+ revision?: string
+ root?: string
+ token?: string
+}
+
+export interface Icloud_Config {
+ root?: string
+ apple_id?: string
+ password?: string
+ trust_token?: string
+ ds_web_auth_token?: string
+ is_china_mainland?: string
+}
+
+export interface Ipfs_Config {
+ endpoint?: string
+ root?: string
+}
+
+export interface Ipmfs_Config {
+ root?: string
+ endpoint?: string
+}
+
+export interface Koofr_Config {
+ root?: string
+ endpoint: string
+ email: string
+ password?: string
+}
+
+export interface Lakefs_Config {
+ endpoint?: string
+ username?: string
+ password?: string
+ root?: string
+ repository?: string
+ branch?: string
+}
+
+export interface Libsql_Config {
+ connection_string?: string
+ auth_token?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Memcached_Config {
+ endpoint?: string
+ root?: string
+ username?: string
+ password?: string
+ default_ttl?: string
+}
+
+export interface Memory_Config {
+ root?: string
+}
+
+export interface Mini_moka_Config {
+ max_capacity?: string
+ time_to_live?: string
+ time_to_idle?: string
+ root?: string
+}
+
+export interface Moka_Config {
+ name?: string
+ max_capacity?: string
+ time_to_live?: string
+ time_to_idle?: string
+ num_segments?: string
+ root?: string
+}
+
+export interface Mongodb_Config {
+ connection_string?: string
+ database?: string
+ collection?: string
+ root?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Monoiofs_Config {
+ root?: string
+}
+
+export interface Mysql_Config {
+ connection_string?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Nebula_graph_Config {
+ host?: string
+ port?: string
+ username?: string
+ password?: string
+ space?: string
+ tag?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Obs_Config {
+ root?: string
+ endpoint?: string
+ access_key_id?: string
+ secret_access_key?: string
+ bucket?: string
+}
+
+export interface Onedrive_Config {
+ access_token?: string
+ root?: string
+}
+
+export interface Oss_Config {
+ root?: string
+ endpoint?: string
+ presign_endpoint?: string
+ bucket: string
+ server_side_encryption?: string
+ server_side_encryption_key_id?: string
+ allow_anonymous?: string
+ access_key_id?: string
+ access_key_secret?: string
+
+ /**
+ * @deprecated: Please use `delete_max_size` instead of `batch_max_operations`
+ */
+ batch_max_operations?: string
+ delete_max_size?: string
+ role_arn?: string
+ role_session_name?: string
+ oidc_provider_arn?: string
+ oidc_token_file?: string
+ sts_endpoint?: string
+}
+
+export interface Pcloud_Config {
+ root?: string
+ endpoint: string
+ username?: string
+ password?: string
+}
+
+export interface Persy_Config {
+ datafile?: string
+ segment?: string
+ index?: string
+}
+
+export interface Postgresql_Config {
+ root?: string
+ connection_string?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Redb_Config {
Review Comment:
we may need some template filter to convert `nebula_graph` to `NebulaGraphConfig`
##########
bindings/nodejs/types.generated.d.ts:
##########
@@ -0,0 +1,584 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Operator } from './generated'
+
+export interface Aliyun_drive_Config {
+ root?: string
+ access_token?: string
+ client_id?: string
+ client_secret?: string
+ refresh_token?: string
+ drive_type: string
+}
+
+export interface Alluxio_Config {
+ root?: string
+ endpoint?: string
+}
+
+export interface Atomicserver_Config {
+ root?: string
+ endpoint?: string
+ private_key?: string
+ public_key?: string
+ parent_resource_id?: string
+}
+
+export interface Azblob_Config {
+ root?: string
+ container: string
+ endpoint?: string
+ account_name?: string
+ account_key?: string
+ encryption_key?: string
+ encryption_key_sha256?: string
+ encryption_algorithm?: string
+ sas_token?: string
+ batch_max_operations?: string
+}
+
+export interface Azdls_Config {
+ root?: string
+ filesystem: string
+ endpoint?: string
+ account_name?: string
+ account_key?: string
+}
+
+export interface Azfile_Config {
+ root?: string
+ endpoint?: string
+ share_name: string
+ account_name?: string
+ account_key?: string
+ sas_token?: string
+}
+
+export interface B2_Config {
+ root?: string
+ application_key_id?: string
+ application_key?: string
+ bucket: string
+ bucket_id: string
+}
+
+export interface Cacache_Config {
+ datadir?: string
+}
+
+export interface Chainsafe_Config {
+ root?: string
+ api_key?: string
+ bucket_id: string
+}
+
+export interface Cloudflare_kv_Config {
+ token?: string
+ account_id?: string
+ namespace_id?: string
+ root?: string
+}
+
+export interface Compfs_Config {
+ root?: string
+}
+
+export interface Cos_Config {
+ root?: string
+ endpoint?: string
+ secret_id?: string
+ secret_key?: string
+ bucket?: string
+ disable_config_load?: string
+}
+
+export interface D1_Config {
+ token?: string
+ account_id?: string
+ database_id?: string
+ root?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Dashmap_Config {
+ root?: string
+}
+
+export interface Dbfs_Config {
+ root?: string
+ endpoint?: string
+ token?: string
+}
+
+export interface Dropbox_Config {
+ root?: string
+ access_token?: string
+ refresh_token?: string
+ client_id?: string
+ client_secret?: string
+}
+
+export interface Fs_Config {
+ root?: string
+ atomic_write_dir?: string
+}
+
+export interface Gcs_Config {
+ root?: string
+ bucket: string
+ endpoint?: string
+ scope?: string
+ service_account?: string
+ credential?: string
+ credential_path?: string
+ predefined_acl?: string
+ default_storage_class?: string
+ allow_anonymous?: string
+ disable_vm_metadata?: string
+ disable_config_load?: string
+ token?: string
+}
+
+export interface Gdrive_Config {
+ root?: string
+ access_token?: string
+ refresh_token?: string
+ client_id?: string
+ client_secret?: string
+}
+
+export interface Ghac_Config {
+ root?: string
+ version?: string
+ endpoint?: string
+ runtime_token?: string
+}
+
+export interface Github_Config {
+ root?: string
+ token?: string
+ owner: string
+ repo: string
+}
+
+export interface Gridfs_Config {
+ connection_string?: string
+ database?: string
+ bucket?: string
+ chunk_size?: string
+ root?: string
+}
+
+export interface Hdfs_native_Config {
+ root?: string
+ url?: string
+ enable_append?: string
+}
+
+export interface Http_Config {
+ endpoint?: string
+ username?: string
+ password?: string
+ token?: string
+ root?: string
+}
+
+export interface Huggingface_Config {
+ repo_type?: string
+ repo_id?: string
+ revision?: string
+ root?: string
+ token?: string
+}
+
+export interface Icloud_Config {
+ root?: string
+ apple_id?: string
+ password?: string
+ trust_token?: string
+ ds_web_auth_token?: string
+ is_china_mainland?: string
+}
+
+export interface Ipfs_Config {
+ endpoint?: string
+ root?: string
+}
+
+export interface Ipmfs_Config {
+ root?: string
+ endpoint?: string
+}
+
+export interface Koofr_Config {
+ root?: string
+ endpoint: string
+ email: string
+ password?: string
+}
+
+export interface Lakefs_Config {
+ endpoint?: string
+ username?: string
+ password?: string
+ root?: string
+ repository?: string
+ branch?: string
+}
+
+export interface Libsql_Config {
+ connection_string?: string
+ auth_token?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Memcached_Config {
+ endpoint?: string
+ root?: string
+ username?: string
+ password?: string
+ default_ttl?: string
+}
+
+export interface Memory_Config {
+ root?: string
+}
+
+export interface Mini_moka_Config {
+ max_capacity?: string
+ time_to_live?: string
+ time_to_idle?: string
+ root?: string
+}
+
+export interface Moka_Config {
+ name?: string
+ max_capacity?: string
+ time_to_live?: string
+ time_to_idle?: string
+ num_segments?: string
+ root?: string
+}
+
+export interface Mongodb_Config {
+ connection_string?: string
+ database?: string
+ collection?: string
+ root?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Monoiofs_Config {
+ root?: string
+}
+
+export interface Mysql_Config {
+ connection_string?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Nebula_graph_Config {
+ host?: string
+ port?: string
+ username?: string
+ password?: string
+ space?: string
+ tag?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Obs_Config {
+ root?: string
+ endpoint?: string
+ access_key_id?: string
+ secret_access_key?: string
+ bucket?: string
+}
+
+export interface Onedrive_Config {
+ access_token?: string
+ root?: string
+}
+
+export interface Oss_Config {
+ root?: string
+ endpoint?: string
+ presign_endpoint?: string
+ bucket: string
+ server_side_encryption?: string
+ server_side_encryption_key_id?: string
+ allow_anonymous?: string
+ access_key_id?: string
+ access_key_secret?: string
+
+ /**
+ * @deprecated: Please use `delete_max_size` instead of `batch_max_operations`
+ */
+ batch_max_operations?: string
+ delete_max_size?: string
+ role_arn?: string
+ role_session_name?: string
+ oidc_provider_arn?: string
+ oidc_token_file?: string
+ sts_endpoint?: string
+}
+
+export interface Pcloud_Config {
+ root?: string
+ endpoint: string
+ username?: string
+ password?: string
+}
+
+export interface Persy_Config {
+ datafile?: string
+ segment?: string
+ index?: string
+}
+
+export interface Postgresql_Config {
+ root?: string
+ connection_string?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Redb_Config {
Review Comment:
we may need some template filter to convert `nebula_graph` to `NebulaGraph`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "trim21 (via GitHub)" <gi...@apache.org>.
trim21 commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898348396
##########
bindings/nodejs/index.js:
##########
@@ -137,6 +137,10 @@ Writer.prototype.createWriteStream = function (options) {
return new WriteStream(this, options)
}
+module.exports.create_operator = function (scheme, options) {
Review Comment:
any idea how? do you suggest to wrap all method of `Operator`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat(bindings/nodejs): generate types and add typed create_operator method [opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #5465:
URL: https://github.com/apache/opendal/pull/5465#discussion_r1898341854
##########
bindings/nodejs/index.js:
##########
@@ -137,6 +137,10 @@ Writer.prototype.createWriteStream = function (options) {
return new WriteStream(this, options)
}
+module.exports.create_operator = function (scheme, options) {
Review Comment:
Can we modify the `Operator`'s constructor API instead of introducing a new API to build the operator?
##########
bindings/nodejs/Cargo.toml:
##########
@@ -45,6 +45,10 @@ default = [
"services-webhdfs",
]
+
+# NOTE: this is the feature we used to build pypi wheels.
+# When enable or disable some features,
+# also need to update dev/src/generate/binding_nodejs.rs `enabled_service` to match it.
Review Comment:
We have repeated this pattern once again. Let's implement a utility function to retrieve all enabled services by cargo metadata.
##########
dev/src/generate/mod.rs:
##########
@@ -30,6 +31,9 @@ pub fn run(language: &str) -> Result<()> {
match language {
"python" | "py" => binding_python::generate(project_root, &services),
+ "nodejs" | "typescript" | "js" | "ts" => {
Review Comment:
Apologies for using the incorrect terminology `language`, which may have caused some confusion. We are referring to the name of the bindings, and we do not plan to build `opendal-typescript`. Therefore, please use `nodejs` or `js` instead.
##########
bindings/nodejs/types.generated.d.ts:
##########
@@ -0,0 +1,584 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Operator } from './generated'
+
+export interface Aliyun_drive_Config {
+ root?: string
+ access_token?: string
+ client_id?: string
+ client_secret?: string
+ refresh_token?: string
+ drive_type: string
+}
+
+export interface Alluxio_Config {
+ root?: string
+ endpoint?: string
+}
+
+export interface Atomicserver_Config {
+ root?: string
+ endpoint?: string
+ private_key?: string
+ public_key?: string
+ parent_resource_id?: string
+}
+
+export interface Azblob_Config {
+ root?: string
+ container: string
+ endpoint?: string
+ account_name?: string
+ account_key?: string
+ encryption_key?: string
+ encryption_key_sha256?: string
+ encryption_algorithm?: string
+ sas_token?: string
+ batch_max_operations?: string
+}
+
+export interface Azdls_Config {
+ root?: string
+ filesystem: string
+ endpoint?: string
+ account_name?: string
+ account_key?: string
+}
+
+export interface Azfile_Config {
+ root?: string
+ endpoint?: string
+ share_name: string
+ account_name?: string
+ account_key?: string
+ sas_token?: string
+}
+
+export interface B2_Config {
+ root?: string
+ application_key_id?: string
+ application_key?: string
+ bucket: string
+ bucket_id: string
+}
+
+export interface Cacache_Config {
+ datadir?: string
+}
+
+export interface Chainsafe_Config {
+ root?: string
+ api_key?: string
+ bucket_id: string
+}
+
+export interface Cloudflare_kv_Config {
+ token?: string
+ account_id?: string
+ namespace_id?: string
+ root?: string
+}
+
+export interface Compfs_Config {
+ root?: string
+}
+
+export interface Cos_Config {
+ root?: string
+ endpoint?: string
+ secret_id?: string
+ secret_key?: string
+ bucket?: string
+ disable_config_load?: string
+}
+
+export interface D1_Config {
+ token?: string
+ account_id?: string
+ database_id?: string
+ root?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Dashmap_Config {
+ root?: string
+}
+
+export interface Dbfs_Config {
+ root?: string
+ endpoint?: string
+ token?: string
+}
+
+export interface Dropbox_Config {
+ root?: string
+ access_token?: string
+ refresh_token?: string
+ client_id?: string
+ client_secret?: string
+}
+
+export interface Fs_Config {
+ root?: string
+ atomic_write_dir?: string
+}
+
+export interface Gcs_Config {
+ root?: string
+ bucket: string
+ endpoint?: string
+ scope?: string
+ service_account?: string
+ credential?: string
+ credential_path?: string
+ predefined_acl?: string
+ default_storage_class?: string
+ allow_anonymous?: string
+ disable_vm_metadata?: string
+ disable_config_load?: string
+ token?: string
+}
+
+export interface Gdrive_Config {
+ root?: string
+ access_token?: string
+ refresh_token?: string
+ client_id?: string
+ client_secret?: string
+}
+
+export interface Ghac_Config {
+ root?: string
+ version?: string
+ endpoint?: string
+ runtime_token?: string
+}
+
+export interface Github_Config {
+ root?: string
+ token?: string
+ owner: string
+ repo: string
+}
+
+export interface Gridfs_Config {
+ connection_string?: string
+ database?: string
+ bucket?: string
+ chunk_size?: string
+ root?: string
+}
+
+export interface Hdfs_native_Config {
+ root?: string
+ url?: string
+ enable_append?: string
+}
+
+export interface Http_Config {
+ endpoint?: string
+ username?: string
+ password?: string
+ token?: string
+ root?: string
+}
+
+export interface Huggingface_Config {
+ repo_type?: string
+ repo_id?: string
+ revision?: string
+ root?: string
+ token?: string
+}
+
+export interface Icloud_Config {
+ root?: string
+ apple_id?: string
+ password?: string
+ trust_token?: string
+ ds_web_auth_token?: string
+ is_china_mainland?: string
+}
+
+export interface Ipfs_Config {
+ endpoint?: string
+ root?: string
+}
+
+export interface Ipmfs_Config {
+ root?: string
+ endpoint?: string
+}
+
+export interface Koofr_Config {
+ root?: string
+ endpoint: string
+ email: string
+ password?: string
+}
+
+export interface Lakefs_Config {
+ endpoint?: string
+ username?: string
+ password?: string
+ root?: string
+ repository?: string
+ branch?: string
+}
+
+export interface Libsql_Config {
+ connection_string?: string
+ auth_token?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Memcached_Config {
+ endpoint?: string
+ root?: string
+ username?: string
+ password?: string
+ default_ttl?: string
+}
+
+export interface Memory_Config {
+ root?: string
+}
+
+export interface Mini_moka_Config {
+ max_capacity?: string
+ time_to_live?: string
+ time_to_idle?: string
+ root?: string
+}
+
+export interface Moka_Config {
+ name?: string
+ max_capacity?: string
+ time_to_live?: string
+ time_to_idle?: string
+ num_segments?: string
+ root?: string
+}
+
+export interface Mongodb_Config {
+ connection_string?: string
+ database?: string
+ collection?: string
+ root?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Monoiofs_Config {
+ root?: string
+}
+
+export interface Mysql_Config {
+ connection_string?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Nebula_graph_Config {
+ host?: string
+ port?: string
+ username?: string
+ password?: string
+ space?: string
+ tag?: string
+ key_field?: string
+ value_field?: string
+ root?: string
+}
+
+export interface Obs_Config {
+ root?: string
+ endpoint?: string
+ access_key_id?: string
+ secret_access_key?: string
+ bucket?: string
+}
+
+export interface Onedrive_Config {
+ access_token?: string
+ root?: string
+}
+
+export interface Oss_Config {
+ root?: string
+ endpoint?: string
+ presign_endpoint?: string
+ bucket: string
+ server_side_encryption?: string
+ server_side_encryption_key_id?: string
+ allow_anonymous?: string
+ access_key_id?: string
+ access_key_secret?: string
+
+ /**
+ * @deprecated: Please use `delete_max_size` instead of `batch_max_operations`
+ */
+ batch_max_operations?: string
+ delete_max_size?: string
+ role_arn?: string
+ role_session_name?: string
+ oidc_provider_arn?: string
+ oidc_token_file?: string
+ sts_endpoint?: string
+}
+
+export interface Pcloud_Config {
+ root?: string
+ endpoint: string
+ username?: string
+ password?: string
+}
+
+export interface Persy_Config {
+ datafile?: string
+ segment?: string
+ index?: string
+}
+
+export interface Postgresql_Config {
+ root?: string
+ connection_string?: string
+ table?: string
+ key_field?: string
+ value_field?: string
+}
+
+export interface Redb_Config {
Review Comment:
Is it normal for js to jave types like `Xxx_Yyy`? Should we use `XxxYyy` instead?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org