@growi/sdk-typescript 1.0.0-RC.0 → 1.0.0-RC.2

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.
Files changed (24) hide show
  1. package/README.md +4 -4
  2. package/README_JP.md +4 -4
  3. package/dist/apiv3/index.d.ts +193 -193
  4. package/dist/generated/v3/index.d.ts +387 -387
  5. package/dist/generated/v3/index.d.ts.map +1 -1
  6. package/dist/generated/v3/index.js +459 -444
  7. package/dist/generated/v3/index.js.map +1 -1
  8. package/dist/generated/v3/index.schemas.d.ts +358 -358
  9. package/dist/generated/v3/index.schemas.d.ts.map +1 -1
  10. package/dist/generated/v3/index.schemas.js +1 -1
  11. package/dist/generated/v3/index.schemas.js.map +1 -1
  12. package/dist/index.d.ts +1 -3
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.js +1 -4
  15. package/dist/index.js.map +1 -1
  16. package/dist/utils/axios-instance.d.ts +13 -2
  17. package/dist/utils/axios-instance.d.ts.map +1 -1
  18. package/dist/utils/axios-instance.js +20 -4
  19. package/dist/utils/axios-instance.js.map +1 -1
  20. package/package.json +3 -3
  21. package/src/generated/v3/index.schemas.ts +358 -358
  22. package/src/generated/v3/index.ts +1243 -1133
  23. package/src/index.ts +1 -5
  24. package/src/utils/axios-instance.ts +21 -5
package/README.md CHANGED
@@ -45,13 +45,13 @@ pnpm add @growi/sdk-typescript
45
45
  ### Client Initialization
46
46
 
47
47
  ```typescript
48
- import { AXIOS_INSTANCE } from '@growi/sdk-typescript';
48
+ import { AXIOS_DEFAULT } from '@growi/sdk-typescript';
49
49
 
50
50
  // Set the base URL of your GROWI instance
51
- AXIOS_INSTANCE.defaults.baseURL = 'https://your-growi-instance.com';
51
+ AXIOS_DEFAULT.setBaseURL('https://your-growi-instance.com');
52
52
 
53
53
  // Set authentication token (if needed)
54
- AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${your-api-token}`;
54
+ AXIOS_DEFAULT.setAuthorizationHeader('your-api-token');
55
55
  ```
56
56
 
57
57
  ### API v3 Usage Example
@@ -111,7 +111,7 @@ try {
111
111
  ```
112
112
  src/
113
113
  ├── utils/
114
- │ └── axios-instance.ts # Custom axios instance
114
+ │ └── axios-instance.ts # Axios instance factory
115
115
  ├── generated/ # Codes generated by Orval
116
116
  │ ├── v1/ # API v1 client
117
117
  │ │ ├── index.ts
package/README_JP.md CHANGED
@@ -45,13 +45,13 @@ pnpm add @growi/sdk-typescript
45
45
  ### クライアントの初期化
46
46
 
47
47
  ```typescript
48
- import { AXIOS_INSTANCE } from '@growi/sdk-typescript';
48
+ import { AXIOS_DEFAULT } from '@growi/sdk-typescript';
49
49
 
50
50
  // GROWI インスタンスのベース URL を設定
51
- AXIOS_INSTANCE.defaults.baseURL = 'https://your-growi-instance.com';
51
+ AXIOS_DEFAULT.setBaseURL('https://your-growi-instance.com');
52
52
 
53
53
  // 認証トークンを設定（必要に応じて）
54
- AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${your-api-token}`;
54
+ AXIOS_DEFAULT.setAuthorizationHeader('your-api-token');
55
55
  ```
56
56
 
57
57
  ### API v3 の使用例
@@ -111,7 +111,7 @@ try {
111
111
  ```
112
112
  src/
113
113
  ├── utils/
114
- │ └── axios-instance.ts # カスタム axios インスタンス
114
+ │ └── axios-instance.ts # Axios インスタンスファクトリー
115
115
  ├── generated/ # Orval で生成されるソースコード群
116
116
  │ ├── v1/ # API v1 クライアント
117
117
  │ │ ├── index.ts