@ollang-dev/sdk 0.3.1

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 (64) hide show
  1. package/bin/tms.js +47 -0
  2. package/dist/browser/index.d.ts +143 -0
  3. package/dist/browser/index.js +2336 -0
  4. package/dist/browser/ollang-browser.min.js +1 -0
  5. package/dist/browser/script-loader.d.ts +1 -0
  6. package/dist/browser/script-loader.js +53 -0
  7. package/dist/client.d.ts +13 -0
  8. package/dist/client.js +60 -0
  9. package/dist/index.d.ts +34 -0
  10. package/dist/index.js +74 -0
  11. package/dist/resources/cms.d.ts +29 -0
  12. package/dist/resources/cms.js +34 -0
  13. package/dist/resources/customInstructions.d.ts +11 -0
  14. package/dist/resources/customInstructions.js +24 -0
  15. package/dist/resources/orders.d.ts +13 -0
  16. package/dist/resources/orders.js +65 -0
  17. package/dist/resources/projects.d.ts +8 -0
  18. package/dist/resources/projects.js +29 -0
  19. package/dist/resources/revisions.d.ts +9 -0
  20. package/dist/resources/revisions.js +18 -0
  21. package/dist/resources/scans.d.ts +38 -0
  22. package/dist/resources/scans.js +52 -0
  23. package/dist/resources/uploads.d.ts +8 -0
  24. package/dist/resources/uploads.js +25 -0
  25. package/dist/tms/config.d.ts +16 -0
  26. package/dist/tms/config.js +172 -0
  27. package/dist/tms/detector/audio-detector.d.ts +27 -0
  28. package/dist/tms/detector/audio-detector.js +168 -0
  29. package/dist/tms/detector/auto-detect.d.ts +1 -0
  30. package/dist/tms/detector/auto-detect.js +152 -0
  31. package/dist/tms/detector/cms-detector.d.ts +17 -0
  32. package/dist/tms/detector/cms-detector.js +94 -0
  33. package/dist/tms/detector/content-type-detector.d.ts +79 -0
  34. package/dist/tms/detector/content-type-detector.js +2 -0
  35. package/dist/tms/detector/hardcoded-detector.d.ts +11 -0
  36. package/dist/tms/detector/hardcoded-detector.js +154 -0
  37. package/dist/tms/detector/i18n-detector.d.ts +16 -0
  38. package/dist/tms/detector/i18n-detector.js +311 -0
  39. package/dist/tms/detector/image-detector.d.ts +11 -0
  40. package/dist/tms/detector/image-detector.js +170 -0
  41. package/dist/tms/detector/text-detector.d.ts +9 -0
  42. package/dist/tms/detector/text-detector.js +35 -0
  43. package/dist/tms/detector/video-detector.d.ts +12 -0
  44. package/dist/tms/detector/video-detector.js +188 -0
  45. package/dist/tms/index.d.ts +12 -0
  46. package/dist/tms/index.js +38 -0
  47. package/dist/tms/multi-content-tms.d.ts +42 -0
  48. package/dist/tms/multi-content-tms.js +230 -0
  49. package/dist/tms/server/index.d.ts +1 -0
  50. package/dist/tms/server/index.js +1473 -0
  51. package/dist/tms/server/strapi-pusher.d.ts +31 -0
  52. package/dist/tms/server/strapi-pusher.js +296 -0
  53. package/dist/tms/server/strapi-schema.d.ts +47 -0
  54. package/dist/tms/server/strapi-schema.js +93 -0
  55. package/dist/tms/tms.d.ts +48 -0
  56. package/dist/tms/tms.js +875 -0
  57. package/dist/tms/types.d.ts +189 -0
  58. package/dist/tms/types.js +2 -0
  59. package/dist/tms/ui-dist/assets/index-5U1Hw3uo.css +1 -0
  60. package/dist/tms/ui-dist/assets/index-HvrqZV5Z.js +149 -0
  61. package/dist/tms/ui-dist/index.html +14 -0
  62. package/dist/types/index.d.ts +174 -0
  63. package/dist/types/index.js +2 -0
  64. package/package.json +98 -0
package/dist/tms/ui-dist/index.html ADDED
@@ -0,0 +1,14 @@
1
+ <!doctype html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <link rel="icon" type="image/svg+xml" href="/vite.svg" />
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7
+ <title>Ollang TMS</title>
8
+ <script type="module" crossorigin src="/assets/index-HvrqZV5Z.js"></script>
9
+ <link rel="stylesheet" crossorigin href="/assets/index-5U1Hw3uo.css">
10
+ </head>
11
+ <body>
12
+ <div id="root"></div>
13
+ </body>
14
+ </html>
package/dist/types/index.d.ts ADDED
@@ -0,0 +1,174 @@
1
+ export interface OllangConfig {
2
+ apiKey: string;
3
+ baseUrl?: string;
4
+ }
5
+ export interface PageOptions {
6
+ page?: number;
7
+ take?: number;
8
+ search?: string;
9
+ orderBy?: string;
10
+ orderDirection?: 'asc' | 'desc';
11
+ }
12
+ export interface PaginationMeta {
13
+ page: number;
14
+ take: number;
15
+ itemCount: number;
16
+ pageCount: number;
17
+ hasPreviousPage: boolean;
18
+ hasNextPage: boolean;
19
+ }
20
+ export type OrderType = 'cc' | 'subtitle' | 'document' | 'aiDubbing' | 'studioDubbing' | 'proofreading' | 'other' | 'revision';
21
+ export type OrderSubType = 'closedCaption' | 'timecodedTranscription';
22
+ export type DubbingStyle = 'overdub' | 'lipsync' | 'audioDescription';
23
+ export interface TargetLanguageConfig {
24
+ language: string;
25
+ isRush: boolean;
26
+ }
27
+ export interface CreateOrderParams {
28
+ orderType: OrderType;
29
+ orderSubType?: OrderSubType;
30
+ dubbingStyle?: DubbingStyle;
31
+ level: number;
32
+ projectId?: string;
33
+ sourceLanguage?: string;
34
+ content?: string;
35
+ targetLanguageConfigs: TargetLanguageConfig[];
36
+ }
37
+ export interface Order {
38
+ id: string;
39
+ orderType: OrderType;
40
+ orderSubType?: OrderSubType;
41
+ dubbingStyle?: DubbingStyle;
42
+ level: number;
43
+ projectId: string;
44
+ targetLanguageConfigs: TargetLanguageConfig[];
45
+ createdAt: string;
46
+ updatedAt: string;
47
+ status?: string;
48
+ }
49
+ export interface ListOrdersParams {
50
+ pageOptions?: PageOptions;
51
+ filter?: {
52
+ status?: string;
53
+ orderType?: OrderType;
54
+ projectId?: string;
55
+ };
56
+ }
57
+ export interface OrdersListResponse {
58
+ data: Order[];
59
+ meta: PaginationMeta;
60
+ }
61
+ export interface RunQcEvaluationParams {
62
+ customPrompt?: string;
63
+ accuracy?: boolean;
64
+ fluency?: boolean;
65
+ tone?: boolean;
66
+ culturalFit?: boolean;
67
+ }
68
+ export interface EvaluationScore {
69
+ name: string;
70
+ score: number;
71
+ details?: string;
72
+ }
73
+ export interface SegmentEvaluation {
74
+ segmentId: string;
75
+ scores?: EvaluationScore[];
76
+ comments?: string;
77
+ }
78
+ export interface RunQcEvaluationResponse {
79
+ success: boolean;
80
+ message: string;
81
+ evalId: string;
82
+ creditsUsed: number;
83
+ isProcessing?: boolean;
84
+ textSummary?: string;
85
+ scores?: EvaluationScore[];
86
+ segmentEvals?: SegmentEvaluation[];
87
+ }
88
+ export interface RerunOrderParams {
89
+ freeReRun?: boolean;
90
+ }
91
+ export interface RerunOrderResponse {
92
+ success: boolean;
93
+ message: string;
94
+ orderId?: string;
95
+ }
96
+ export interface DocEntity {
97
+ id: string;
98
+ name: string;
99
+ url?: string;
100
+ }
101
+ export interface Project {
102
+ id: string;
103
+ name: string;
104
+ sourceLanguage: string;
105
+ createdAt: string;
106
+ folderId: string;
107
+ projectDocs: DocEntity[];
108
+ ordersCount?: number;
109
+ }
110
+ export interface ListProjectsParams {
111
+ pageOptions?: PageOptions;
112
+ }
113
+ export interface ProjectsListResponse {
114
+ data: Project[];
115
+ meta: PaginationMeta;
116
+ }
117
+ export type RevisionType = 'timing' | 'translation' | 'formatting' | 'other';
118
+ export interface CreateRevisionParams {
119
+ type: RevisionType;
120
+ time: string;
121
+ description?: string;
122
+ }
123
+ export interface Revision {
124
+ id: string;
125
+ type: RevisionType;
126
+ time: string;
127
+ description?: string;
128
+ createdAt: string;
129
+ orderId: string;
130
+ }
131
+ export interface OrderNote {
132
+ details: string;
133
+ timeStamp: string;
134
+ }
135
+ export interface DirectUploadParams {
136
+ file: File | Blob;
137
+ name: string;
138
+ sourceLanguage: string;
139
+ notes?: OrderNote[];
140
+ }
141
+ export interface DirectUploadResponse {
142
+ projectId: string;
143
+ }
144
+ export interface UploadVttParams {
145
+ file: File | Blob;
146
+ orderId: string;
147
+ }
148
+ export interface UploadVttResponse {
149
+ success: boolean;
150
+ message?: string;
151
+ }
152
+ export interface CreateCustomInstructionParams {
153
+ key: string;
154
+ value: string;
155
+ description?: string;
156
+ }
157
+ export interface UpdateCustomInstructionParams {
158
+ key?: string;
159
+ value?: string;
160
+ description?: string;
161
+ }
162
+ export interface CustomInstruction {
163
+ id: string;
164
+ key: string;
165
+ value: string;
166
+ description?: string;
167
+ createdAt: string;
168
+ updatedAt: string;
169
+ }
170
+ export interface CustomInstructionSuggestion {
171
+ key: string;
172
+ value: string;
173
+ description?: string;
174
+ }
package/dist/types/index.js ADDED
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json ADDED
@@ -0,0 +1,98 @@
1
+ {
2
+ "name": "@ollang-dev/sdk",
3
+ "version": "0.3.1",
4
+ "description": "Official TypeScript/Node.js SDK for Ollang API - Translation, Transcription, Dubbing, Closed Captioning, and Translation Management System",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "bin": {
8
+ "ollang-tms": "./bin/tms.js"
9
+ },
10
+ "exports": {
11
+ ".": {
12
+ "types": "./dist/index.d.ts",
13
+ "default": "./dist/index.js"
14
+ },
15
+ "./browser": {
16
+ "types": "./dist/browser/index.d.ts",
17
+ "default": "./dist/browser/index.js"
18
+ }
19
+ },
20
+ "files": [
21
+ "dist",
22
+ "bin",
23
+ "README.md",
24
+ "LICENSE"
25
+ ],
26
+ "scripts": {
27
+ "build": "npm run build:node && npm run build:ui && npm run build:browser",
28
+ "build:node": "tsc",
29
+ "build:ui": "npm run build:ui:react && npm run build:ui:copy",
30
+ "build:ui:react": "cd src/tms/ui-react && npm install && npm run build && cd ../../..",
31
+ "build:ui:copy": "mkdir -p dist/tms && cp -r src/tms/ui-dist dist/tms/",
32
+ "build:browser": "webpack --config webpack.browser.config.js",
33
+ "build:browser:watch": "webpack --config webpack.browser.config.js --watch",
34
+ "copy:browser": "cp dist/browser/ollang-browser.min.js ../ollang-home/src/assets/",
35
+ "dev": "tsc --watch",
36
+ "dev:ui": "cd src/tms/ui-react && npm run dev",
37
+ "dev:browser": "npm run build:browser:watch & npm run watch:copy",
38
+ "watch:copy": "nodemon --watch dist/browser/ollang-browser.min.js --exec 'npm run copy:browser'",
39
+ "prepublishOnly": "npm run build",
40
+ "test": "jest",
41
+ "test:tms:local": "npm run build:node && node dist/examples/test-tms-local.js",
42
+ "test:browser": "open examples/browser-cms-integration.html",
43
+ "lint": "eslint src --ext .ts",
44
+ "format": "prettier --write \"src/**/*.ts\""
45
+ },
46
+ "keywords": [
47
+ "ollang",
48
+ "translation",
49
+ "transcription",
50
+ "dubbing",
51
+ "closed-captioning",
52
+ "subtitles",
53
+ "localization",
54
+ "sdk",
55
+ "api",
56
+ "typescript"
57
+ ],
58
+ "author": "Ollang",
59
+ "license": "MIT",
60
+ "repository": {
61
+ "type": "git",
62
+ "url": "https://github.com/ollang/sdk.git"
63
+ },
64
+ "bugs": {
65
+ "url": "https://github.com/ollang/sdk/issues"
66
+ },
67
+ "homepage": "https://github.com/ollang/sdk#readme",
68
+ "engines": {
69
+ "node": ">=16.0.0"
70
+ },
71
+ "dependencies": {
72
+ "axios": "^1.6.0",
73
+ "express": "^4.18.2",
74
+ "form-data": "^4.0.0",
75
+ "open": "^8.4.0"
76
+ },
77
+ "devDependencies": {
78
+ "@types/express": "^4.17.17",
79
+ "@types/node": "^20.0.0",
80
+ "@types/react": "^18.3.28",
81
+ "@typescript-eslint/eslint-plugin": "^6.15.0",
82
+ "@typescript-eslint/parser": "^6.15.0",
83
+ "eslint": "^8.55.0",
84
+ "prettier": "^3.1.0",
85
+ "ts-loader": "^9.5.0",
86
+ "typescript": "^5.3.0",
87
+ "webpack": "^5.89.0",
88
+ "webpack-cli": "^5.1.4"
89
+ },
90
+ "peerDependencies": {
91
+ "react": ">=16.8.0"
92
+ },
93
+ "peerDependenciesMeta": {
94
+ "react": {
95
+ "optional": true
96
+ }
97
+ }
98
+ }