@ops-ai/electron-feature-flags-toggly 1.0.0
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.
- package/CHANGELOG.md +14 -0
- package/LICENSE +21 -0
- package/README.md +156 -0
- package/dist/index.cjs +80 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +72 -0
- package/dist/index.js.map +1 -0
- package/dist/main/index.cjs +853 -0
- package/dist/main/index.cjs.map +1 -0
- package/dist/main/index.d.cts +131 -0
- package/dist/main/index.d.ts +131 -0
- package/dist/main/index.js +830 -0
- package/dist/main/index.js.map +1 -0
- package/dist/preload/index.cjs +72 -0
- package/dist/preload/index.cjs.map +1 -0
- package/dist/preload/index.d.cts +7 -0
- package/dist/preload/index.d.ts +7 -0
- package/dist/preload/index.js +70 -0
- package/dist/preload/index.js.map +1 -0
- package/dist/react/index.cjs +146 -0
- package/dist/react/index.cjs.map +1 -0
- package/dist/react/index.d.cts +39 -0
- package/dist/react/index.d.ts +39 -0
- package/dist/react/index.js +141 -0
- package/dist/react/index.js.map +1 -0
- package/dist/renderer/index.cjs +80 -0
- package/dist/renderer/index.cjs.map +1 -0
- package/dist/renderer/index.d.cts +13 -0
- package/dist/renderer/index.d.ts +13 -0
- package/dist/renderer/index.js +72 -0
- package/dist/renderer/index.js.map +1 -0
- package/dist/types-BbMSwQVV.d.cts +47 -0
- package/dist/types-BbMSwQVV.d.ts +47 -0
- package/package.json +132 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
## [1.0.0] - 2026-09-11
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- Initial `@ops-ai/electron-feature-flags-toggly` release
|
|
10
|
+
- Main-process client using frontend App Key + `/evaluated-signed`
|
|
11
|
+
- Disk cache under Electron `userData`, signature verification via `@ops-ai/toggly-signed-defs`
|
|
12
|
+
- WebSocket live updates in the main process with renderer fan-out
|
|
13
|
+
- Preload `exposeToggly()` and Flutter-like renderer API (`init` in main; `isFeatureOn` / `Feature` in renderer)
|
|
14
|
+
- Optional React helpers: `Feature`, `useFeatureFlag`
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2021-2026 opsAI LLC
|
|
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
ADDED
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
# @ops-ai/electron-feature-flags-toggly
|
|
2
|
+
|
|
3
|
+
Feature flags for Electron apps with a Flutter-like DX. The **main process** owns your App Key, fetches `/evaluated-signed` definitions, verifies signatures, caches under `userData`, and keeps a live WebSocket. The renderer uses `window.toggly` (exposed from preload) — no App Key in Chromium.
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
|
7
|
+
<a href="https://docs.toggly.io"><img src="https://img.shields.io/badge/docs-docs.toggly.io-blue.svg" alt="Documentation"></a>
|
|
8
|
+
<a href="https://toggly.io"><img src="https://img.shields.io/badge/website-toggly.io-0A66C2.svg" alt="Website"></a>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @ops-ai/electron-feature-flags-toggly
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Peer: Electron ≥ 28. React ≥ 18 is optional (only for `@ops-ai/electron-feature-flags-toggly/react`).
|
|
18
|
+
|
|
19
|
+
## Setup (3 snippets)
|
|
20
|
+
|
|
21
|
+
### 1. Main process
|
|
22
|
+
|
|
23
|
+
```js
|
|
24
|
+
import { app, BrowserWindow } from 'electron'
|
|
25
|
+
import {
|
|
26
|
+
initToggly,
|
|
27
|
+
registerTogglyIpc,
|
|
28
|
+
isFeatureOn,
|
|
29
|
+
} from '@ops-ai/electron-feature-flags-toggly/main'
|
|
30
|
+
|
|
31
|
+
await app.whenReady()
|
|
32
|
+
|
|
33
|
+
await initToggly({
|
|
34
|
+
appKey: process.env.TOGGLY_APP_KEY,
|
|
35
|
+
environment: 'Production',
|
|
36
|
+
userDataPath: app.getPath('userData'),
|
|
37
|
+
flagDefaults: {
|
|
38
|
+
NewDashboard: false,
|
|
39
|
+
BetaMenu: false,
|
|
40
|
+
},
|
|
41
|
+
})
|
|
42
|
+
|
|
43
|
+
registerTogglyIpc(require('electron').ipcMain, () => BrowserWindow.getAllWindows())
|
|
44
|
+
|
|
45
|
+
// Trusted process can gate menus / windows directly:
|
|
46
|
+
if (isFeatureOn('BetaMenu')) {
|
|
47
|
+
// …
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### 2. Preload
|
|
52
|
+
|
|
53
|
+
```js
|
|
54
|
+
import { exposeToggly } from '@ops-ai/electron-feature-flags-toggly/preload'
|
|
55
|
+
|
|
56
|
+
exposeToggly()
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Wire this file as `webPreferences.preload` with `contextIsolation: true`.
|
|
60
|
+
|
|
61
|
+
### 3. Renderer
|
|
62
|
+
|
|
63
|
+
```js
|
|
64
|
+
import { isFeatureOn, evaluateFeatureGate } from '@ops-ai/electron-feature-flags-toggly'
|
|
65
|
+
|
|
66
|
+
if (isFeatureOn('NewDashboard')) {
|
|
67
|
+
showDashboard()
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
const unlock = evaluateFeatureGate(
|
|
71
|
+
['FeatureA', 'FeatureB'],
|
|
72
|
+
'any',
|
|
73
|
+
false,
|
|
74
|
+
)
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## React (optional)
|
|
78
|
+
|
|
79
|
+
```tsx
|
|
80
|
+
import { Feature, useFeatureFlag } from '@ops-ai/electron-feature-flags-toggly/react'
|
|
81
|
+
|
|
82
|
+
export function App() {
|
|
83
|
+
const { isEnabled } = useFeatureFlag('NewDashboard')
|
|
84
|
+
|
|
85
|
+
return (
|
|
86
|
+
<>
|
|
87
|
+
<Feature featureKey="NewDashboard">
|
|
88
|
+
<NewDashboard />
|
|
89
|
+
</Feature>
|
|
90
|
+
<Feature featureKey="NewDashboard" negate>
|
|
91
|
+
<LegacyDashboard />
|
|
92
|
+
</Feature>
|
|
93
|
+
{isEnabled && <Badge />}
|
|
94
|
+
</>
|
|
95
|
+
)
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## API overview
|
|
100
|
+
|
|
101
|
+
| Surface | Entry |
|
|
102
|
+
|---------|--------|
|
|
103
|
+
| Main | `@ops-ai/electron-feature-flags-toggly/main` |
|
|
104
|
+
| Preload | `@ops-ai/electron-feature-flags-toggly/preload` |
|
|
105
|
+
| Renderer | `@ops-ai/electron-feature-flags-toggly` or `/renderer` |
|
|
106
|
+
| React | `@ops-ai/electron-feature-flags-toggly/react` |
|
|
107
|
+
|
|
108
|
+
### Main
|
|
109
|
+
|
|
110
|
+
- `initToggly(config)` → `Promise<flags>`
|
|
111
|
+
- `getToggly()` / `closeToggly()`
|
|
112
|
+
- `isFeatureOn` / `isFeatureOff` / `evaluateFeatureGate`
|
|
113
|
+
- `setContext` / `clearContext` / `addHook`
|
|
114
|
+
- `registerTogglyIpc(ipcMain, getWindows)`
|
|
115
|
+
|
|
116
|
+
### Renderer (`window.toggly`)
|
|
117
|
+
|
|
118
|
+
- `isFeatureOn(key, entityContext?, kind?)`
|
|
119
|
+
- `evaluateFeatureGate(keys, requirement?, negate?, entityContext?, kind?)`
|
|
120
|
+
- `getFlags()` / `setContext` / `clearContext`
|
|
121
|
+
- `onFlagsUpdated(callback)` → unsubscribe
|
|
122
|
+
|
|
123
|
+
## Configuration
|
|
124
|
+
|
|
125
|
+
| Option | Default | Notes |
|
|
126
|
+
|--------|---------|--------|
|
|
127
|
+
| `appKey` | — | Frontend App Key |
|
|
128
|
+
| `environment` | `Production` | |
|
|
129
|
+
| `baseURI` | `https://definitions.toggly.io` | |
|
|
130
|
+
| `userDataPath` | **required** | `app.getPath('userData')` |
|
|
131
|
+
| `flagDefaults` | `{}` | Offline / no-key fallback |
|
|
132
|
+
| `identity` / `groups` / `claims` | | Targeting context |
|
|
133
|
+
| `verifySignatures` | `false` | ES256 via JWKS |
|
|
134
|
+
| `enableLiveUpdates` | `true` when `appKey` set | WebSocket in main |
|
|
135
|
+
| `connectTimeout` | `5000` | ms |
|
|
136
|
+
| `featureFlagsRefreshInterval` | `180000` | ms |
|
|
137
|
+
|
|
138
|
+
## Entity context
|
|
139
|
+
|
|
140
|
+
Entity-gated flags fail closed without a context. Pass an entity on each read:
|
|
141
|
+
|
|
142
|
+
```js
|
|
143
|
+
isFeatureOn('OrderBadge', order, 'Order')
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## Signed definitions
|
|
147
|
+
|
|
148
|
+
Set `verifySignatures: true` to verify evaluated-signed envelopes in the main process before caching or serving results to the renderer.
|
|
149
|
+
|
|
150
|
+
## Example
|
|
151
|
+
|
|
152
|
+
See [`example/`](./example) for a minimal main + preload + HTML app.
|
|
153
|
+
|
|
154
|
+
## License
|
|
155
|
+
|
|
156
|
+
MIT © opsAI LLC
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
// src/renderer/index.ts
|
|
4
|
+
function tryBridge() {
|
|
5
|
+
if (typeof window === "undefined" || !window.toggly) {
|
|
6
|
+
return null;
|
|
7
|
+
}
|
|
8
|
+
return window.toggly;
|
|
9
|
+
}
|
|
10
|
+
function isFeatureOn(key, entityContext, kind) {
|
|
11
|
+
const bridge = tryBridge();
|
|
12
|
+
if (!bridge) {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
return bridge.isFeatureOn(key, entityContext, kind);
|
|
16
|
+
}
|
|
17
|
+
function isFeatureOff(key, entityContext, kind) {
|
|
18
|
+
const bridge = tryBridge();
|
|
19
|
+
if (!bridge) {
|
|
20
|
+
return true;
|
|
21
|
+
}
|
|
22
|
+
return bridge.isFeatureOff(key, entityContext, kind);
|
|
23
|
+
}
|
|
24
|
+
function evaluateFeatureGate(keys, requirement, negate, entityContext, kind) {
|
|
25
|
+
const bridge = tryBridge();
|
|
26
|
+
if (!bridge) {
|
|
27
|
+
return negate ?? false;
|
|
28
|
+
}
|
|
29
|
+
return bridge.evaluateFeatureGate(keys, requirement, negate, entityContext, kind);
|
|
30
|
+
}
|
|
31
|
+
function getFlags() {
|
|
32
|
+
const bridge = tryBridge();
|
|
33
|
+
if (!bridge) {
|
|
34
|
+
return Promise.reject(
|
|
35
|
+
new Error(
|
|
36
|
+
"window.toggly is not available. Call exposeToggly() from your preload script."
|
|
37
|
+
)
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
return bridge.getFlags();
|
|
41
|
+
}
|
|
42
|
+
function setContext(context) {
|
|
43
|
+
const bridge = tryBridge();
|
|
44
|
+
if (!bridge) {
|
|
45
|
+
return Promise.reject(
|
|
46
|
+
new Error(
|
|
47
|
+
"window.toggly is not available. Call exposeToggly() from your preload script."
|
|
48
|
+
)
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
return bridge.setContext(context);
|
|
52
|
+
}
|
|
53
|
+
function clearContext() {
|
|
54
|
+
const bridge = tryBridge();
|
|
55
|
+
if (!bridge) {
|
|
56
|
+
return Promise.reject(
|
|
57
|
+
new Error(
|
|
58
|
+
"window.toggly is not available. Call exposeToggly() from your preload script."
|
|
59
|
+
)
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
return bridge.clearContext();
|
|
63
|
+
}
|
|
64
|
+
function onFlagsUpdated(callback) {
|
|
65
|
+
const bridge = tryBridge();
|
|
66
|
+
if (!bridge) {
|
|
67
|
+
return () => void 0;
|
|
68
|
+
}
|
|
69
|
+
return bridge.onFlagsUpdated(callback);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
exports.clearContext = clearContext;
|
|
73
|
+
exports.evaluateFeatureGate = evaluateFeatureGate;
|
|
74
|
+
exports.getFlags = getFlags;
|
|
75
|
+
exports.isFeatureOff = isFeatureOff;
|
|
76
|
+
exports.isFeatureOn = isFeatureOn;
|
|
77
|
+
exports.onFlagsUpdated = onFlagsUpdated;
|
|
78
|
+
exports.setContext = setContext;
|
|
79
|
+
//# sourceMappingURL=index.cjs.map
|
|
80
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/renderer/index.ts"],"names":[],"mappings":";;;AAQA,SAAS,SAAA,GAAiC;AACxC,EAAA,IAAI,OAAO,MAAA,KAAW,WAAA,IAAe,CAAC,OAAO,MAAA,EAAQ;AACnD,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,MAAA,CAAO,MAAA;AAChB;AAEO,SAAS,WAAA,CACd,GAAA,EACA,aAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,MAAA,CAAO,WAAA,CAAY,GAAA,EAAK,aAAA,EAAe,IAAI,CAAA;AACpD;AAEO,SAAS,YAAA,CACd,GAAA,EACA,aAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,MAAA,CAAO,YAAA,CAAa,GAAA,EAAK,aAAA,EAAe,IAAI,CAAA;AACrD;AAEO,SAAS,mBAAA,CACd,IAAA,EACA,WAAA,EACA,MAAA,EACA,eACA,IAAA,EACS;AACT,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,MAAA,IAAU,KAAA;AAAA,EACnB;AACA,EAAA,OAAO,OAAO,mBAAA,CAAoB,IAAA,EAAM,WAAA,EAAa,MAAA,EAAQ,eAAe,IAAI,CAAA;AAClF;AAEO,SAAS,QAAA,GAA0C;AACxD,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,MACb,IAAI,KAAA;AAAA,QACF;AAAA;AACF,KACF;AAAA,EACF;AACA,EAAA,OAAO,OAAO,QAAA,EAAS;AACzB;AAEO,SAAS,WAAW,OAAA,EAAyD;AAClF,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,MACb,IAAI,KAAA;AAAA,QACF;AAAA;AACF,KACF;AAAA,EACF;AACA,EAAA,OAAO,MAAA,CAAO,WAAW,OAAO,CAAA;AAClC;AAEO,SAAS,YAAA,GAA8C;AAC5D,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,MACb,IAAI,KAAA;AAAA,QACF;AAAA;AACF,KACF;AAAA,EACF;AACA,EAAA,OAAO,OAAO,YAAA,EAAa;AAC7B;AAEO,SAAS,eACd,QAAA,EACY;AACZ,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,MAAM,MAAA;AAAA,EACf;AACA,EAAA,OAAO,MAAA,CAAO,eAAe,QAAQ,CAAA;AACvC","file":"index.cjs","sourcesContent":["import type {\n EntityContextInput,\n FeatureFlagsSnapshot,\n FeatureRequirement,\n SetContextInput,\n TogglyBridge,\n} from '../types.js'\n\nfunction tryBridge(): TogglyBridge | null {\n if (typeof window === 'undefined' || !window.toggly) {\n return null\n }\n return window.toggly\n}\n\nexport function isFeatureOn(\n key: string,\n entityContext?: EntityContextInput,\n kind?: string,\n): boolean {\n const bridge = tryBridge()\n if (!bridge) {\n return false\n }\n return bridge.isFeatureOn(key, entityContext, kind)\n}\n\nexport function isFeatureOff(\n key: string,\n entityContext?: EntityContextInput,\n kind?: string,\n): boolean {\n const bridge = tryBridge()\n if (!bridge) {\n return true\n }\n return bridge.isFeatureOff(key, entityContext, kind)\n}\n\nexport function evaluateFeatureGate(\n keys: string[],\n requirement?: FeatureRequirement | string,\n negate?: boolean,\n entityContext?: EntityContextInput,\n kind?: string,\n): boolean {\n const bridge = tryBridge()\n if (!bridge) {\n return negate ?? false\n }\n return bridge.evaluateFeatureGate(keys, requirement, negate, entityContext, kind)\n}\n\nexport function getFlags(): Promise<FeatureFlagsSnapshot> {\n const bridge = tryBridge()\n if (!bridge) {\n return Promise.reject(\n new Error(\n 'window.toggly is not available. Call exposeToggly() from your preload script.',\n ),\n )\n }\n return bridge.getFlags()\n}\n\nexport function setContext(context: SetContextInput): Promise<FeatureFlagsSnapshot> {\n const bridge = tryBridge()\n if (!bridge) {\n return Promise.reject(\n new Error(\n 'window.toggly is not available. Call exposeToggly() from your preload script.',\n ),\n )\n }\n return bridge.setContext(context)\n}\n\nexport function clearContext(): Promise<FeatureFlagsSnapshot> {\n const bridge = tryBridge()\n if (!bridge) {\n return Promise.reject(\n new Error(\n 'window.toggly is not available. Call exposeToggly() from your preload script.',\n ),\n )\n }\n return bridge.clearContext()\n}\n\nexport function onFlagsUpdated(\n callback: (flags: FeatureFlagsSnapshot) => void,\n): () => void {\n const bridge = tryBridge()\n if (!bridge) {\n return () => undefined\n }\n return bridge.onFlagsUpdated(callback)\n}\n\nexport type { TogglyBridge, FeatureFlagsSnapshot, FeatureRequirement, SetContextInput }\n"]}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { clearContext, evaluateFeatureGate, getFlags, isFeatureOff, isFeatureOn, onFlagsUpdated, setContext } from './renderer/index.cjs';
|
|
2
|
+
export { E as EntityContextInput, a as FeatureFlagsSnapshot, F as FeatureRequirement, S as SetContextInput, b as TogglyBridge, T as TogglyElectronConfig } from './types-BbMSwQVV.cjs';
|
|
3
|
+
export { Hook } from '@ops-ai/toggly-hooks-types';
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { clearContext, evaluateFeatureGate, getFlags, isFeatureOff, isFeatureOn, onFlagsUpdated, setContext } from './renderer/index.js';
|
|
2
|
+
export { E as EntityContextInput, a as FeatureFlagsSnapshot, F as FeatureRequirement, S as SetContextInput, b as TogglyBridge, T as TogglyElectronConfig } from './types-BbMSwQVV.js';
|
|
3
|
+
export { Hook } from '@ops-ai/toggly-hooks-types';
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
// src/renderer/index.ts
|
|
2
|
+
function tryBridge() {
|
|
3
|
+
if (typeof window === "undefined" || !window.toggly) {
|
|
4
|
+
return null;
|
|
5
|
+
}
|
|
6
|
+
return window.toggly;
|
|
7
|
+
}
|
|
8
|
+
function isFeatureOn(key, entityContext, kind) {
|
|
9
|
+
const bridge = tryBridge();
|
|
10
|
+
if (!bridge) {
|
|
11
|
+
return false;
|
|
12
|
+
}
|
|
13
|
+
return bridge.isFeatureOn(key, entityContext, kind);
|
|
14
|
+
}
|
|
15
|
+
function isFeatureOff(key, entityContext, kind) {
|
|
16
|
+
const bridge = tryBridge();
|
|
17
|
+
if (!bridge) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
return bridge.isFeatureOff(key, entityContext, kind);
|
|
21
|
+
}
|
|
22
|
+
function evaluateFeatureGate(keys, requirement, negate, entityContext, kind) {
|
|
23
|
+
const bridge = tryBridge();
|
|
24
|
+
if (!bridge) {
|
|
25
|
+
return negate ?? false;
|
|
26
|
+
}
|
|
27
|
+
return bridge.evaluateFeatureGate(keys, requirement, negate, entityContext, kind);
|
|
28
|
+
}
|
|
29
|
+
function getFlags() {
|
|
30
|
+
const bridge = tryBridge();
|
|
31
|
+
if (!bridge) {
|
|
32
|
+
return Promise.reject(
|
|
33
|
+
new Error(
|
|
34
|
+
"window.toggly is not available. Call exposeToggly() from your preload script."
|
|
35
|
+
)
|
|
36
|
+
);
|
|
37
|
+
}
|
|
38
|
+
return bridge.getFlags();
|
|
39
|
+
}
|
|
40
|
+
function setContext(context) {
|
|
41
|
+
const bridge = tryBridge();
|
|
42
|
+
if (!bridge) {
|
|
43
|
+
return Promise.reject(
|
|
44
|
+
new Error(
|
|
45
|
+
"window.toggly is not available. Call exposeToggly() from your preload script."
|
|
46
|
+
)
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
return bridge.setContext(context);
|
|
50
|
+
}
|
|
51
|
+
function clearContext() {
|
|
52
|
+
const bridge = tryBridge();
|
|
53
|
+
if (!bridge) {
|
|
54
|
+
return Promise.reject(
|
|
55
|
+
new Error(
|
|
56
|
+
"window.toggly is not available. Call exposeToggly() from your preload script."
|
|
57
|
+
)
|
|
58
|
+
);
|
|
59
|
+
}
|
|
60
|
+
return bridge.clearContext();
|
|
61
|
+
}
|
|
62
|
+
function onFlagsUpdated(callback) {
|
|
63
|
+
const bridge = tryBridge();
|
|
64
|
+
if (!bridge) {
|
|
65
|
+
return () => void 0;
|
|
66
|
+
}
|
|
67
|
+
return bridge.onFlagsUpdated(callback);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export { clearContext, evaluateFeatureGate, getFlags, isFeatureOff, isFeatureOn, onFlagsUpdated, setContext };
|
|
71
|
+
//# sourceMappingURL=index.js.map
|
|
72
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/renderer/index.ts"],"names":[],"mappings":";AAQA,SAAS,SAAA,GAAiC;AACxC,EAAA,IAAI,OAAO,MAAA,KAAW,WAAA,IAAe,CAAC,OAAO,MAAA,EAAQ;AACnD,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,MAAA,CAAO,MAAA;AAChB;AAEO,SAAS,WAAA,CACd,GAAA,EACA,aAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,MAAA,CAAO,WAAA,CAAY,GAAA,EAAK,aAAA,EAAe,IAAI,CAAA;AACpD;AAEO,SAAS,YAAA,CACd,GAAA,EACA,aAAA,EACA,IAAA,EACS;AACT,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,MAAA,CAAO,YAAA,CAAa,GAAA,EAAK,aAAA,EAAe,IAAI,CAAA;AACrD;AAEO,SAAS,mBAAA,CACd,IAAA,EACA,WAAA,EACA,MAAA,EACA,eACA,IAAA,EACS;AACT,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,MAAA,IAAU,KAAA;AAAA,EACnB;AACA,EAAA,OAAO,OAAO,mBAAA,CAAoB,IAAA,EAAM,WAAA,EAAa,MAAA,EAAQ,eAAe,IAAI,CAAA;AAClF;AAEO,SAAS,QAAA,GAA0C;AACxD,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,MACb,IAAI,KAAA;AAAA,QACF;AAAA;AACF,KACF;AAAA,EACF;AACA,EAAA,OAAO,OAAO,QAAA,EAAS;AACzB;AAEO,SAAS,WAAW,OAAA,EAAyD;AAClF,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,MACb,IAAI,KAAA;AAAA,QACF;AAAA;AACF,KACF;AAAA,EACF;AACA,EAAA,OAAO,MAAA,CAAO,WAAW,OAAO,CAAA;AAClC;AAEO,SAAS,YAAA,GAA8C;AAC5D,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,OAAA,CAAQ,MAAA;AAAA,MACb,IAAI,KAAA;AAAA,QACF;AAAA;AACF,KACF;AAAA,EACF;AACA,EAAA,OAAO,OAAO,YAAA,EAAa;AAC7B;AAEO,SAAS,eACd,QAAA,EACY;AACZ,EAAA,MAAM,SAAS,SAAA,EAAU;AACzB,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,MAAM,MAAA;AAAA,EACf;AACA,EAAA,OAAO,MAAA,CAAO,eAAe,QAAQ,CAAA;AACvC","file":"index.js","sourcesContent":["import type {\n EntityContextInput,\n FeatureFlagsSnapshot,\n FeatureRequirement,\n SetContextInput,\n TogglyBridge,\n} from '../types.js'\n\nfunction tryBridge(): TogglyBridge | null {\n if (typeof window === 'undefined' || !window.toggly) {\n return null\n }\n return window.toggly\n}\n\nexport function isFeatureOn(\n key: string,\n entityContext?: EntityContextInput,\n kind?: string,\n): boolean {\n const bridge = tryBridge()\n if (!bridge) {\n return false\n }\n return bridge.isFeatureOn(key, entityContext, kind)\n}\n\nexport function isFeatureOff(\n key: string,\n entityContext?: EntityContextInput,\n kind?: string,\n): boolean {\n const bridge = tryBridge()\n if (!bridge) {\n return true\n }\n return bridge.isFeatureOff(key, entityContext, kind)\n}\n\nexport function evaluateFeatureGate(\n keys: string[],\n requirement?: FeatureRequirement | string,\n negate?: boolean,\n entityContext?: EntityContextInput,\n kind?: string,\n): boolean {\n const bridge = tryBridge()\n if (!bridge) {\n return negate ?? false\n }\n return bridge.evaluateFeatureGate(keys, requirement, negate, entityContext, kind)\n}\n\nexport function getFlags(): Promise<FeatureFlagsSnapshot> {\n const bridge = tryBridge()\n if (!bridge) {\n return Promise.reject(\n new Error(\n 'window.toggly is not available. Call exposeToggly() from your preload script.',\n ),\n )\n }\n return bridge.getFlags()\n}\n\nexport function setContext(context: SetContextInput): Promise<FeatureFlagsSnapshot> {\n const bridge = tryBridge()\n if (!bridge) {\n return Promise.reject(\n new Error(\n 'window.toggly is not available. Call exposeToggly() from your preload script.',\n ),\n )\n }\n return bridge.setContext(context)\n}\n\nexport function clearContext(): Promise<FeatureFlagsSnapshot> {\n const bridge = tryBridge()\n if (!bridge) {\n return Promise.reject(\n new Error(\n 'window.toggly is not available. Call exposeToggly() from your preload script.',\n ),\n )\n }\n return bridge.clearContext()\n}\n\nexport function onFlagsUpdated(\n callback: (flags: FeatureFlagsSnapshot) => void,\n): () => void {\n const bridge = tryBridge()\n if (!bridge) {\n return () => undefined\n }\n return bridge.onFlagsUpdated(callback)\n}\n\nexport type { TogglyBridge, FeatureFlagsSnapshot, FeatureRequirement, SetContextInput }\n"]}
|