@offscript/sdk 0.1.0 → 0.1.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 (38) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +3 -3
  3. package/dist/adapters/nuxt.cjs +3 -3
  4. package/dist/adapters/nuxt.js +2 -2
  5. package/dist/adapters/vanilla.cjs +5 -5
  6. package/dist/adapters/vanilla.js +3 -3
  7. package/dist/adapters/vue.cjs +3 -3
  8. package/dist/adapters/vue.js +2 -2
  9. package/dist/{chunk-MBYNQSKA.js → chunk-HECPMGDC.js} +3 -3
  10. package/dist/{chunk-MBYNQSKA.js.map → chunk-HECPMGDC.js.map} +1 -1
  11. package/dist/{chunk-3NX2AGXM.cjs → chunk-I6JPZAQA.cjs} +738 -31
  12. package/dist/chunk-I6JPZAQA.cjs.map +1 -0
  13. package/dist/{chunk-3OSCH7J2.js → chunk-IBEPWI7S.js} +729 -22
  14. package/dist/chunk-IBEPWI7S.js.map +1 -0
  15. package/dist/{chunk-B6GO5FE5.cjs → chunk-KQVK5EJR.cjs} +4 -3
  16. package/dist/chunk-KQVK5EJR.cjs.map +1 -0
  17. package/dist/{chunk-HAPNSHFG.cjs → chunk-TBPD2LMI.cjs} +4 -4
  18. package/dist/{chunk-HAPNSHFG.cjs.map → chunk-TBPD2LMI.cjs.map} +1 -1
  19. package/dist/{chunk-LFXHB4PN.js → chunk-WUFW7TEL.js} +4 -3
  20. package/dist/chunk-WUFW7TEL.js.map +1 -0
  21. package/dist/core/OffscriptSDK.d.ts +19 -0
  22. package/dist/core/SessionManager.d.ts +1 -0
  23. package/dist/index.cjs +25 -25
  24. package/dist/index.js +3 -3
  25. package/dist/playwright.cjs +13 -13
  26. package/dist/playwright.js +1 -1
  27. package/dist/privacy/DataSanitizer.d.ts +1 -0
  28. package/dist/recorders/ContextRecorder.d.ts +1 -1
  29. package/dist/types/config.d.ts +11 -0
  30. package/dist/types/events.d.ts +2 -0
  31. package/dist/types/session.d.ts +2 -2
  32. package/dist/ui/RecordingControls.d.ts +60 -0
  33. package/docs/api-contract.md +1 -1
  34. package/package.json +5 -4
  35. package/dist/chunk-3NX2AGXM.cjs.map +0 -1
  36. package/dist/chunk-3OSCH7J2.js.map +0 -1
  37. package/dist/chunk-B6GO5FE5.cjs.map +0 -1
  38. package/dist/chunk-LFXHB4PN.js.map +0 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Soffact
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -29,7 +29,7 @@ await offscript.init(); // retoma sessão persistida (relo
29
29
  await offscript.startRecording({
30
30
  testCaseId: "test-case-id",
31
31
  executionId: "execution-id",
32
- sessionToken: "short-lived-session-token", // emitido pelo SEU backend; nunca uma chave permanente
32
+ // sessionToken: "short-lived-session-token", // opcional: pode vir de ?offscript_token=
33
33
  });
34
34
  await offscript.pauseRecording(); // retomar gera um novo snapshot completo
35
35
  await offscript.resumeRecording();
@@ -50,7 +50,7 @@ offscript.on("sessionStart" | "sessionEnd" | "flush" | "overflow" | "disabled",
50
50
  Erros tipados: `ConfigError`, `AuthError`, `SessionExpiredError`, `SessionDisabledError`, `InvalidStateError`, `TransportError` (todos estendem `OffscriptError` com `code`).
51
51
 
52
52
  ### Autorização
53
- A gravação só começa depois que `POST /sdk/sessions` autoriza o token e responde `recording.enabled: true`. O token é guardado só em `sessionStorage` (escopo da aba) e usado em `Authorization: Bearer`; renovações chegam em `sessionToken` nas respostas. O backend pode desativar remotamente via heartbeat.
53
+ A gravação só começa depois que `POST /sdk/sessions` autoriza o token e responde `recording.enabled: true`. O token pode ser informado em `startRecording` ou lido automaticamente de `offscript_token` na query string. Depois de capturado, esse parâmetro é removido da barra de endereço; o token é guardado só em `sessionStorage` (escopo da aba) e usado em `Authorization: Bearer` em todas as chamadas, inclusive na finalização. Renovações chegam em `sessionToken` nas respostas. O backend pode desativar remotamente via heartbeat.
54
54
 
55
55
  ## Configuração
56
56
 
@@ -70,7 +70,7 @@ A gravação só começa depois que `POST /sdk/sessions` autoriza o token e resp
70
70
  | `recording.rrwebRecordCanvas` | `false` | Canvas (custoso) |
71
71
  | `recording.testIdAttributes` | `data-testid, data-test, data-cy, data-qa` | Atributos de teste para seletores |
72
72
  | `recording.stableAttributes` | `name, data-id, aria-label` | Atributos estáveis extras |
73
- | `privacy.maskSensitiveInputs` | `true` | Máscara de inputs no replay |
73
+ | `privacy.maskSensitiveInputs` | `false` | Máscara de inputs no replay |
74
74
  | `privacy.maskAllText` | `false` | Máscara de todo texto no replay |
75
75
  | `privacy.captureRequestBodies / captureResponseBodies` | `false` | Bodies HTTP |
76
76
  | `privacy.allowedInputSelectors` | `[data-offscript-allow]` | Campos cujo valor pode ser gravado |
@@ -1,12 +1,12 @@
1
1
  'use strict';
2
2
 
3
- var chunk3NX2AGXM_cjs = require('../chunk-3NX2AGXM.cjs');
4
- require('../chunk-B6GO5FE5.cjs');
3
+ var chunkI6JPZAQA_cjs = require('../chunk-I6JPZAQA.cjs');
4
+ require('../chunk-KQVK5EJR.cjs');
5
5
 
6
6
  // src/adapters/nuxt.ts
7
7
  function createNuxtOffscript(config) {
8
8
  if (typeof window === "undefined") return null;
9
- const sdk = new chunk3NX2AGXM_cjs.Offscript(config);
9
+ const sdk = new chunkI6JPZAQA_cjs.Offscript(config);
10
10
  void sdk.init().catch(() => void 0);
11
11
  return sdk;
12
12
  }
@@ -1,5 +1,5 @@
1
- import { Offscript } from '../chunk-3OSCH7J2.js';
2
- import '../chunk-LFXHB4PN.js';
1
+ import { Offscript } from '../chunk-IBEPWI7S.js';
2
+ import '../chunk-WUFW7TEL.js';
3
3
 
4
4
  // src/adapters/nuxt.ts
5
5
  function createNuxtOffscript(config) {
@@ -1,18 +1,18 @@
1
1
  'use strict';
2
2
 
3
- var chunkHAPNSHFG_cjs = require('../chunk-HAPNSHFG.cjs');
4
- require('../chunk-3NX2AGXM.cjs');
5
- require('../chunk-B6GO5FE5.cjs');
3
+ var chunkTBPD2LMI_cjs = require('../chunk-TBPD2LMI.cjs');
4
+ require('../chunk-I6JPZAQA.cjs');
5
+ require('../chunk-KQVK5EJR.cjs');
6
6
 
7
7
 
8
8
 
9
9
  Object.defineProperty(exports, "createOffscript", {
10
10
  enumerable: true,
11
- get: function () { return chunkHAPNSHFG_cjs.createOffscript; }
11
+ get: function () { return chunkTBPD2LMI_cjs.createOffscript; }
12
12
  });
13
13
  Object.defineProperty(exports, "startOffscript", {
14
14
  enumerable: true,
15
- get: function () { return chunkHAPNSHFG_cjs.startOffscript; }
15
+ get: function () { return chunkTBPD2LMI_cjs.startOffscript; }
16
16
  });
17
17
  //# sourceMappingURL=vanilla.cjs.map
18
18
  //# sourceMappingURL=vanilla.cjs.map
@@ -1,5 +1,5 @@
1
- export { createOffscript, startOffscript } from '../chunk-MBYNQSKA.js';
2
- import '../chunk-3OSCH7J2.js';
3
- import '../chunk-LFXHB4PN.js';
1
+ export { createOffscript, startOffscript } from '../chunk-HECPMGDC.js';
2
+ import '../chunk-IBEPWI7S.js';
3
+ import '../chunk-WUFW7TEL.js';
4
4
  //# sourceMappingURL=vanilla.js.map
5
5
  //# sourceMappingURL=vanilla.js.map
@@ -1,13 +1,13 @@
1
1
  'use strict';
2
2
 
3
- var chunk3NX2AGXM_cjs = require('../chunk-3NX2AGXM.cjs');
4
- require('../chunk-B6GO5FE5.cjs');
3
+ var chunkI6JPZAQA_cjs = require('../chunk-I6JPZAQA.cjs');
4
+ require('../chunk-KQVK5EJR.cjs');
5
5
 
6
6
  // src/adapters/vue.ts
7
7
  var OFFSCRIPT_KEY = "$offscript";
8
8
  var OffscriptPlugin = {
9
9
  install(app, config) {
10
- const sdk = new chunk3NX2AGXM_cjs.Offscript(config);
10
+ const sdk = new chunkI6JPZAQA_cjs.Offscript(config);
11
11
  void sdk.init().catch(() => void 0);
12
12
  if (app.config?.globalProperties) {
13
13
  app.config.globalProperties[OFFSCRIPT_KEY] = sdk;
@@ -1,5 +1,5 @@
1
- import { Offscript } from '../chunk-3OSCH7J2.js';
2
- import '../chunk-LFXHB4PN.js';
1
+ import { Offscript } from '../chunk-IBEPWI7S.js';
2
+ import '../chunk-WUFW7TEL.js';
3
3
 
4
4
  // src/adapters/vue.ts
5
5
  var OFFSCRIPT_KEY = "$offscript";
@@ -1,4 +1,4 @@
1
- import { Offscript } from './chunk-3OSCH7J2.js';
1
+ import { Offscript } from './chunk-IBEPWI7S.js';
2
2
 
3
3
  // src/adapters/vanilla.ts
4
4
  async function createOffscript(config) {
@@ -13,5 +13,5 @@ async function startOffscript(config, start) {
13
13
  }
14
14
 
15
15
  export { createOffscript, startOffscript };
16
- //# sourceMappingURL=chunk-MBYNQSKA.js.map
17
- //# sourceMappingURL=chunk-MBYNQSKA.js.map
16
+ //# sourceMappingURL=chunk-HECPMGDC.js.map
17
+ //# sourceMappingURL=chunk-HECPMGDC.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/adapters/vanilla.ts"],"names":[],"mappings":";;;AAKA,eAAsB,gBAAgB,MAAA,EAA6C;AACjF,EAAA,MAAM,GAAA,GAAM,IAAI,SAAA,CAAU,MAAM,CAAA;AAChC,EAAA,MAAM,IAAI,IAAA,EAAK;AACf,EAAA,OAAO,GAAA;AACT;AAEA,eAAsB,cAAA,CAAe,QAAyB,KAAA,EAAkD;AAC9G,EAAA,MAAM,GAAA,GAAM,MAAM,eAAA,CAAgB,MAAM,CAAA;AACxC,EAAA,MAAM,GAAA,CAAI,eAAe,KAAK,CAAA;AAC9B,EAAA,OAAO,GAAA;AACT","file":"chunk-MBYNQSKA.js","sourcesContent":["import { Offscript } from \"../core/OffscriptSDK\";\nimport type { OffscriptConfig } from \"../types/config\";\nimport type { StartRecordingOptions } from \"../types/session\";\n\n/** Atalho para aplicações JS tradicionais, Blade e MPA: inicializa e retoma sessões persistidas. */\nexport async function createOffscript(config: OffscriptConfig): Promise<Offscript> {\n const sdk = new Offscript(config);\n await sdk.init();\n return sdk;\n}\n\nexport async function startOffscript(config: OffscriptConfig, start: StartRecordingOptions): Promise<Offscript> {\n const sdk = await createOffscript(config);\n await sdk.startRecording(start);\n return sdk;\n}\n"]}
1
+ {"version":3,"sources":["../src/adapters/vanilla.ts"],"names":[],"mappings":";;;AAKA,eAAsB,gBAAgB,MAAA,EAA6C;AACjF,EAAA,MAAM,GAAA,GAAM,IAAI,SAAA,CAAU,MAAM,CAAA;AAChC,EAAA,MAAM,IAAI,IAAA,EAAK;AACf,EAAA,OAAO,GAAA;AACT;AAEA,eAAsB,cAAA,CAAe,QAAyB,KAAA,EAAkD;AAC9G,EAAA,MAAM,GAAA,GAAM,MAAM,eAAA,CAAgB,MAAM,CAAA;AACxC,EAAA,MAAM,GAAA,CAAI,eAAe,KAAK,CAAA;AAC9B,EAAA,OAAO,GAAA;AACT","file":"chunk-HECPMGDC.js","sourcesContent":["import { Offscript } from \"../core/OffscriptSDK\";\nimport type { OffscriptConfig } from \"../types/config\";\nimport type { StartRecordingOptions } from \"../types/session\";\n\n/** Atalho para aplicações JS tradicionais, Blade e MPA: inicializa e retoma sessões persistidas. */\nexport async function createOffscript(config: OffscriptConfig): Promise<Offscript> {\n const sdk = new Offscript(config);\n await sdk.init();\n return sdk;\n}\n\nexport async function startOffscript(config: OffscriptConfig, start: StartRecordingOptions): Promise<Offscript> {\n const sdk = await createOffscript(config);\n await sdk.startRecording(start);\n return sdk;\n}\n"]}