@serve.zone/interfaces 30.2.0 → 30.3.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/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/data/index.d.ts +1 -0
- package/dist_ts/data/index.js +2 -1
- package/dist_ts/data/privatenetwork.d.ts +96 -0
- package/dist_ts/data/privatenetwork.js +168 -0
- package/dist_ts/requests/network.d.ts +62 -0
- package/package.json +2 -2
- package/readme.md +26 -0
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/data/index.ts +1 -0
- package/ts/data/privatenetwork.ts +234 -0
- package/ts/requests/network.ts +48 -0
package/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2026-09-09 - 30.3.0
|
|
4
|
+
|
|
5
|
+
### Fixes
|
|
6
|
+
|
|
7
|
+
- bump @git.zone/tstest to ^4.1.1 (deps-dev)
|
|
8
|
+
- Updated the test runner dev dependency from ^4.0.0 to ^4.1.1.
|
|
9
|
+
|
|
10
|
+
### Features
|
|
11
|
+
|
|
12
|
+
- add private network contracts and typed requests (private-networks)
|
|
13
|
+
- Introduce private network data models, snapshot validators, contract limits, and FQDN construction.
|
|
14
|
+
- Add Cloudly typed requests for listing, reading, mutating, and attaching service private networks.
|
|
15
|
+
- Document private network DNS, membership, retirement, and revocation semantics.
|
|
16
|
+
|
|
3
17
|
## 2026-09-09 - 30.2.0
|
|
4
18
|
|
|
5
19
|
### Features
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@serve.zone/interfaces',
|
|
6
|
-
version: '30.
|
|
6
|
+
version: '30.3.0',
|
|
7
7
|
description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLHVGQUF1RjtDQUNyRyxDQUFBIn0=
|
package/dist_ts/data/index.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export * from './isolatedrestore.golden.js';
|
|
|
22
22
|
export * from './mail.js';
|
|
23
23
|
export * from './nodecredential.js';
|
|
24
24
|
export * from './nodeenrollment.js';
|
|
25
|
+
export * from './privatenetwork.js';
|
|
25
26
|
export * from './registry.js';
|
|
26
27
|
export * from './runtimeassignment.js';
|
|
27
28
|
export * from './runtimeconfig.js';
|
package/dist_ts/data/index.js
CHANGED
|
@@ -22,6 +22,7 @@ export * from './isolatedrestore.golden.js';
|
|
|
22
22
|
export * from './mail.js';
|
|
23
23
|
export * from './nodecredential.js';
|
|
24
24
|
export * from './nodeenrollment.js';
|
|
25
|
+
export * from './privatenetwork.js';
|
|
25
26
|
export * from './registry.js';
|
|
26
27
|
export * from './runtimeassignment.js';
|
|
27
28
|
export * from './runtimeconfig.js';
|
|
@@ -42,4 +43,4 @@ export * from './traffic.js';
|
|
|
42
43
|
export * from './user.js';
|
|
43
44
|
export * from './version.js';
|
|
44
45
|
export * from './webpush.js';
|
|
45
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
46
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLGlCQUFpQixDQUFDO0FBQ2hDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYywwQkFBMEIsQ0FBQztBQUN6QyxjQUFjLDBCQUEwQixDQUFDO0FBQ3pDLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxZQUFZLENBQUM7QUFDM0IsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLGdCQUFnQixDQUFDO0FBQy9CLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxzQkFBc0IsQ0FBQztBQUNyQyxjQUFjLDZCQUE2QixDQUFDO0FBQzVDLGNBQWMsV0FBVyxDQUFDO0FBQzFCLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMsZUFBZSxDQUFDO0FBQzlCLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMsNkJBQTZCLENBQUM7QUFDNUMsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxnQkFBZ0IsQ0FBQztBQUMvQixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsZUFBZSxDQUFDO0FBQzlCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyxtQkFBbUIsQ0FBQztBQUNsQyxjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLG9CQUFvQixDQUFDO0FBQ25DLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsV0FBVyxDQUFDO0FBQzFCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsY0FBYyxDQUFDIn0=
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/** Cloudly owns these definitions. Membership never follows node placement. */
|
|
2
|
+
export interface IPrivateNetworkPolicyV1 {
|
|
3
|
+
connectivity: 'member-full-mesh';
|
|
4
|
+
/** null denies external resolution; private names are never forwarded. */
|
|
5
|
+
externalDns: {
|
|
6
|
+
upstreams: Array<{
|
|
7
|
+
address: string;
|
|
8
|
+
port: number;
|
|
9
|
+
}>;
|
|
10
|
+
/** true requires an empty suffix list; false requires explicit suffixes. */
|
|
11
|
+
allowAnyPublicName: boolean;
|
|
12
|
+
permittedSuffixes: string[];
|
|
13
|
+
} | null;
|
|
14
|
+
}
|
|
15
|
+
export interface IPrivateNetworkV1 {
|
|
16
|
+
schemaVersion: 1;
|
|
17
|
+
id: string;
|
|
18
|
+
organizationId: string;
|
|
19
|
+
/** Immutable server-owned keys; display-name changes do not rename DNS. */
|
|
20
|
+
organizationDnsKey: string;
|
|
21
|
+
networkDnsKey: string;
|
|
22
|
+
name: string;
|
|
23
|
+
revision: number;
|
|
24
|
+
state: 'active' | 'retiring' | 'retired';
|
|
25
|
+
policy: IPrivateNetworkPolicyV1;
|
|
26
|
+
createdAt: number;
|
|
27
|
+
updatedAt: number;
|
|
28
|
+
}
|
|
29
|
+
export interface IPrivateNetworkAttachmentV1 {
|
|
30
|
+
networkId: string;
|
|
31
|
+
/** Sorted unique single-label aliases, reserved per network for this service. */
|
|
32
|
+
aliases: string[];
|
|
33
|
+
}
|
|
34
|
+
/** Desired membership only. Acceptance is neither packet enforcement nor DNS readiness. */
|
|
35
|
+
export interface IServicePrivateNetworksV1 {
|
|
36
|
+
schemaVersion: 1;
|
|
37
|
+
organizationId: string;
|
|
38
|
+
serviceId: string;
|
|
39
|
+
revision: number;
|
|
40
|
+
/** Sorted by networkId; every network must have the same canonical organization. */
|
|
41
|
+
attachments: IPrivateNetworkAttachmentV1[];
|
|
42
|
+
/** Exactly the sole attachment, or explicit selection/null when several exist. */
|
|
43
|
+
defaultNetworkId: string | null;
|
|
44
|
+
}
|
|
45
|
+
interface IPrivateNetworkMutationBaseV1 {
|
|
46
|
+
schemaVersion: 1;
|
|
47
|
+
organizationId: string;
|
|
48
|
+
/** Retain the exact body and this identifier across retries. */
|
|
49
|
+
mutationId: string;
|
|
50
|
+
}
|
|
51
|
+
export type TPrivateNetworkMutationV1 = IPrivateNetworkMutationBaseV1 & ({
|
|
52
|
+
operation: 'create';
|
|
53
|
+
expectedRevision: null;
|
|
54
|
+
name: string;
|
|
55
|
+
policy: IPrivateNetworkPolicyV1;
|
|
56
|
+
} | {
|
|
57
|
+
operation: 'update';
|
|
58
|
+
networkId: string;
|
|
59
|
+
expectedRevision: number;
|
|
60
|
+
name: string;
|
|
61
|
+
policy: IPrivateNetworkPolicyV1;
|
|
62
|
+
}
|
|
63
|
+
/** Retirement completes only after outstanding grants are denied or independently fenced. */
|
|
64
|
+
| {
|
|
65
|
+
operation: 'retire';
|
|
66
|
+
networkId: string;
|
|
67
|
+
expectedRevision: number;
|
|
68
|
+
});
|
|
69
|
+
export interface ISetServicePrivateNetworksV1 extends IPrivateNetworkMutationBaseV1 {
|
|
70
|
+
serviceId: string;
|
|
71
|
+
/** null means the service has never had a membership document; not an empty list. */
|
|
72
|
+
expectedRevision: number | null;
|
|
73
|
+
attachments: IPrivateNetworkAttachmentV1[];
|
|
74
|
+
defaultNetworkId: string | null;
|
|
75
|
+
}
|
|
76
|
+
export declare const privateNetworkV1Contract: Readonly<{
|
|
77
|
+
readonly privateRoot: "internal.";
|
|
78
|
+
readonly maximumAttachments: 16;
|
|
79
|
+
readonly maximumAliasesPerAttachment: 32;
|
|
80
|
+
readonly maximumUpstreams: 4;
|
|
81
|
+
readonly maximumPermittedSuffixes: 64;
|
|
82
|
+
readonly maximumDnsLeaseMs: 900000;
|
|
83
|
+
readonly maximumPositiveTtlSeconds: 5;
|
|
84
|
+
readonly maximumNegativeTtlSeconds: 1;
|
|
85
|
+
readonly packetAuthorityLifetime: "until-applied-denial-or-independent-fence";
|
|
86
|
+
readonly omission: "no-effect";
|
|
87
|
+
}>;
|
|
88
|
+
/** Structural validation only; backend IP ownership/reachability and policy fences are required. */
|
|
89
|
+
export declare const snapshotPrivateNetworkPolicyV1: (value: unknown) => IPrivateNetworkPolicyV1;
|
|
90
|
+
export declare const snapshotPrivateNetworkV1: (value: unknown) => IPrivateNetworkV1;
|
|
91
|
+
export declare const snapshotServicePrivateNetworksV1: (value: unknown) => IServicePrivateNetworksV1;
|
|
92
|
+
export declare const snapshotSetServicePrivateNetworksV1: (value: unknown) => ISetServicePrivateNetworksV1;
|
|
93
|
+
export declare const snapshotPrivateNetworkMutationV1: (value: unknown) => TPrivateNetworkMutationV1;
|
|
94
|
+
/** Pure naming helper; it does not reserve a name or create any public DNS/ingress record. */
|
|
95
|
+
export declare const buildPrivateNetworkFqdnV1: (networkValue: unknown, aliasValue: unknown) => string;
|
|
96
|
+
export {};
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
export const privateNetworkV1Contract = Object.freeze({
|
|
2
|
+
privateRoot: 'internal.',
|
|
3
|
+
maximumAttachments: 16,
|
|
4
|
+
maximumAliasesPerAttachment: 32,
|
|
5
|
+
maximumUpstreams: 4,
|
|
6
|
+
maximumPermittedSuffixes: 64,
|
|
7
|
+
maximumDnsLeaseMs: 900_000,
|
|
8
|
+
maximumPositiveTtlSeconds: 5,
|
|
9
|
+
maximumNegativeTtlSeconds: 1,
|
|
10
|
+
packetAuthorityLifetime: 'until-applied-denial-or-independent-fence',
|
|
11
|
+
omission: 'no-effect',
|
|
12
|
+
});
|
|
13
|
+
const fail = () => { throw new Error('Private network contract rejected.'); };
|
|
14
|
+
function requireValue(value) { if (!value)
|
|
15
|
+
fail(); }
|
|
16
|
+
const safe = (operation) => { try {
|
|
17
|
+
return operation();
|
|
18
|
+
}
|
|
19
|
+
catch {
|
|
20
|
+
return fail();
|
|
21
|
+
} };
|
|
22
|
+
const object = (value, keys) => {
|
|
23
|
+
requireValue(value !== null && typeof value === 'object' && !Array.isArray(value));
|
|
24
|
+
requireValue(Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
|
|
25
|
+
const actual = Reflect.ownKeys(value);
|
|
26
|
+
requireValue(actual.length === keys.length && keys.every(key => actual.includes(key)));
|
|
27
|
+
const result = Object.create(null);
|
|
28
|
+
for (const key of keys) {
|
|
29
|
+
const descriptor = Object.getOwnPropertyDescriptor(value, key);
|
|
30
|
+
requireValue(descriptor?.enumerable && Object.hasOwn(descriptor, 'value'));
|
|
31
|
+
result[key] = descriptor.value;
|
|
32
|
+
}
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
const array = (value, maximum, read) => {
|
|
36
|
+
requireValue(Array.isArray(value) && Object.getPrototypeOf(value) === Array.prototype && value.length <= maximum);
|
|
37
|
+
requireValue(Reflect.ownKeys(value).length === value.length + 1);
|
|
38
|
+
const result = [];
|
|
39
|
+
for (let index = 0; index < value.length; index++) {
|
|
40
|
+
const descriptor = Object.getOwnPropertyDescriptor(value, String(index));
|
|
41
|
+
requireValue(descriptor?.enumerable && Object.hasOwn(descriptor, 'value'));
|
|
42
|
+
result.push(read(descriptor.value));
|
|
43
|
+
}
|
|
44
|
+
return result;
|
|
45
|
+
};
|
|
46
|
+
const identifier = (value) => {
|
|
47
|
+
requireValue(typeof value === 'string' && /^[A-Za-z0-9][A-Za-z0-9:._-]{0,199}$/.test(value));
|
|
48
|
+
return value;
|
|
49
|
+
};
|
|
50
|
+
const counter = (value) => {
|
|
51
|
+
requireValue(typeof value === 'number' && Number.isSafeInteger(value) && value > 0 && value < Number.MAX_SAFE_INTEGER);
|
|
52
|
+
return value;
|
|
53
|
+
};
|
|
54
|
+
const name = (value) => {
|
|
55
|
+
requireValue(typeof value === 'string' && value.length > 0 && value.length <= 128
|
|
56
|
+
&& value === value.trim() && !/[\u0000-\u001f\u007f-\u009f\ud800-\udfff]/u.test(value));
|
|
57
|
+
return value;
|
|
58
|
+
};
|
|
59
|
+
const dnsKey = (value, prefix) => {
|
|
60
|
+
requireValue(typeof value === 'string' && new RegExp(`^${prefix}-[a-z2-7]{26}$`).test(value));
|
|
61
|
+
return value;
|
|
62
|
+
};
|
|
63
|
+
const label = (value) => {
|
|
64
|
+
requireValue(typeof value === 'string' && value.length <= 63
|
|
65
|
+
&& /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/.test(value)
|
|
66
|
+
&& !['localhost', 'internal', 'resolver', 'ns', 'ns1', 'hostmaster'].includes(value));
|
|
67
|
+
return value;
|
|
68
|
+
};
|
|
69
|
+
const sorted = (values) => {
|
|
70
|
+
requireValue(values.every((value, index) => index === 0 || values[index - 1] < value));
|
|
71
|
+
return values;
|
|
72
|
+
};
|
|
73
|
+
const ipv4 = (value) => {
|
|
74
|
+
requireValue(typeof value === 'string');
|
|
75
|
+
const parts = value.split('.');
|
|
76
|
+
requireValue(parts.length === 4 && parts.every(part => /^(?:0|[1-9][0-9]{0,2})$/.test(part) && Number(part) <= 255));
|
|
77
|
+
requireValue(Number(parts[0]) > 0 && Number(parts[0]) < 224 && value !== '255.255.255.255');
|
|
78
|
+
return value;
|
|
79
|
+
};
|
|
80
|
+
const publicSuffix = (value) => {
|
|
81
|
+
requireValue(typeof value === 'string' && value.length <= 253 && value.endsWith('.'));
|
|
82
|
+
const labels = value.slice(0, -1).split('.');
|
|
83
|
+
requireValue(labels.length >= 2 && labels.every(part => part.length <= 63
|
|
84
|
+
&& /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/.test(part))
|
|
85
|
+
&& !['internal', 'localhost', 'local', 'arpa'].includes(labels[labels.length - 1]));
|
|
86
|
+
return value;
|
|
87
|
+
};
|
|
88
|
+
/** Structural validation only; backend IP ownership/reachability and policy fences are required. */
|
|
89
|
+
export const snapshotPrivateNetworkPolicyV1 = (value) => safe(() => {
|
|
90
|
+
const policy = object(value, ['connectivity', 'externalDns']);
|
|
91
|
+
requireValue(policy.connectivity === 'member-full-mesh');
|
|
92
|
+
if (policy.externalDns === null)
|
|
93
|
+
return { connectivity: 'member-full-mesh', externalDns: null };
|
|
94
|
+
const external = object(policy.externalDns, ['upstreams', 'allowAnyPublicName', 'permittedSuffixes']);
|
|
95
|
+
const upstreams = array(external.upstreams, privateNetworkV1Contract.maximumUpstreams, entry => {
|
|
96
|
+
const upstream = object(entry, ['address', 'port']);
|
|
97
|
+
const port = counter(upstream.port);
|
|
98
|
+
requireValue(port <= 65535);
|
|
99
|
+
return { address: ipv4(upstream.address), port };
|
|
100
|
+
});
|
|
101
|
+
requireValue(upstreams.length > 0 && new Set(upstreams.map(upstream => `${upstream.address}:${upstream.port}`)).size === upstreams.length);
|
|
102
|
+
requireValue(typeof external.allowAnyPublicName === 'boolean');
|
|
103
|
+
const permittedSuffixes = sorted(array(external.permittedSuffixes, privateNetworkV1Contract.maximumPermittedSuffixes, publicSuffix));
|
|
104
|
+
requireValue(external.allowAnyPublicName ? permittedSuffixes.length === 0 : permittedSuffixes.length > 0);
|
|
105
|
+
return { connectivity: 'member-full-mesh', externalDns: {
|
|
106
|
+
upstreams, allowAnyPublicName: external.allowAnyPublicName, permittedSuffixes,
|
|
107
|
+
} };
|
|
108
|
+
});
|
|
109
|
+
const membership = (attachmentsValue, defaultValue) => {
|
|
110
|
+
const attachments = array(attachmentsValue, privateNetworkV1Contract.maximumAttachments, entry => {
|
|
111
|
+
const attachment = object(entry, ['networkId', 'aliases']);
|
|
112
|
+
return { networkId: identifier(attachment.networkId),
|
|
113
|
+
aliases: sorted(array(attachment.aliases, privateNetworkV1Contract.maximumAliasesPerAttachment, label)) };
|
|
114
|
+
});
|
|
115
|
+
sorted(attachments.map(attachment => attachment.networkId));
|
|
116
|
+
const defaultNetworkId = defaultValue === null ? null : identifier(defaultValue);
|
|
117
|
+
requireValue(defaultNetworkId === null || attachments.some(attachment => attachment.networkId === defaultNetworkId));
|
|
118
|
+
requireValue(attachments.length !== 1 || defaultNetworkId === attachments[0].networkId);
|
|
119
|
+
return { attachments, defaultNetworkId };
|
|
120
|
+
};
|
|
121
|
+
export const snapshotPrivateNetworkV1 = (value) => safe(() => {
|
|
122
|
+
const network = object(value, ['schemaVersion', 'id', 'organizationId', 'organizationDnsKey', 'networkDnsKey',
|
|
123
|
+
'name', 'revision', 'state', 'policy', 'createdAt', 'updatedAt']);
|
|
124
|
+
requireValue(network.schemaVersion === 1 && ['active', 'retiring', 'retired'].includes(network.state));
|
|
125
|
+
const createdAt = counter(network.createdAt);
|
|
126
|
+
const updatedAt = counter(network.updatedAt);
|
|
127
|
+
requireValue(updatedAt >= createdAt);
|
|
128
|
+
return { schemaVersion: 1, id: identifier(network.id), organizationId: identifier(network.organizationId),
|
|
129
|
+
organizationDnsKey: dnsKey(network.organizationDnsKey, 'o'), networkDnsKey: dnsKey(network.networkDnsKey, 'n'),
|
|
130
|
+
name: name(network.name), revision: counter(network.revision), state: network.state,
|
|
131
|
+
policy: snapshotPrivateNetworkPolicyV1(network.policy), createdAt, updatedAt };
|
|
132
|
+
});
|
|
133
|
+
export const snapshotServicePrivateNetworksV1 = (value) => safe(() => {
|
|
134
|
+
const service = object(value, ['schemaVersion', 'organizationId', 'serviceId', 'revision', 'attachments', 'defaultNetworkId']);
|
|
135
|
+
requireValue(service.schemaVersion === 1);
|
|
136
|
+
return { schemaVersion: 1, organizationId: identifier(service.organizationId), serviceId: identifier(service.serviceId),
|
|
137
|
+
revision: counter(service.revision), ...membership(service.attachments, service.defaultNetworkId) };
|
|
138
|
+
});
|
|
139
|
+
export const snapshotSetServicePrivateNetworksV1 = (value) => safe(() => {
|
|
140
|
+
const request = object(value, ['schemaVersion', 'organizationId', 'serviceId', 'mutationId', 'expectedRevision', 'attachments', 'defaultNetworkId']);
|
|
141
|
+
requireValue(request.schemaVersion === 1);
|
|
142
|
+
return { schemaVersion: 1, organizationId: identifier(request.organizationId), serviceId: identifier(request.serviceId),
|
|
143
|
+
mutationId: identifier(request.mutationId), expectedRevision: request.expectedRevision === null ? null : counter(request.expectedRevision),
|
|
144
|
+
...membership(request.attachments, request.defaultNetworkId) };
|
|
145
|
+
});
|
|
146
|
+
export const snapshotPrivateNetworkMutationV1 = (value) => safe(() => {
|
|
147
|
+
requireValue(value !== null && typeof value === 'object');
|
|
148
|
+
const operation = Object.getOwnPropertyDescriptor(value, 'operation')?.value;
|
|
149
|
+
requireValue(operation === 'create' || operation === 'update' || operation === 'retire');
|
|
150
|
+
const request = object(value, ['schemaVersion', 'organizationId', 'mutationId', 'operation', 'expectedRevision',
|
|
151
|
+
...(operation === 'create' ? [] : ['networkId']), ...(operation === 'retire' ? [] : ['name', 'policy'])]);
|
|
152
|
+
requireValue(request.schemaVersion === 1);
|
|
153
|
+
const base = { schemaVersion: 1, organizationId: identifier(request.organizationId), mutationId: identifier(request.mutationId) };
|
|
154
|
+
if (operation === 'create') {
|
|
155
|
+
requireValue(request.expectedRevision === null);
|
|
156
|
+
return { ...base, operation, expectedRevision: null, name: name(request.name), policy: snapshotPrivateNetworkPolicyV1(request.policy) };
|
|
157
|
+
}
|
|
158
|
+
const current = { networkId: identifier(request.networkId), expectedRevision: counter(request.expectedRevision) };
|
|
159
|
+
if (operation === 'retire')
|
|
160
|
+
return { ...base, ...current, operation };
|
|
161
|
+
return { ...base, ...current, operation, name: name(request.name), policy: snapshotPrivateNetworkPolicyV1(request.policy) };
|
|
162
|
+
});
|
|
163
|
+
/** Pure naming helper; it does not reserve a name or create any public DNS/ingress record. */
|
|
164
|
+
export const buildPrivateNetworkFqdnV1 = (networkValue, aliasValue) => safe(() => {
|
|
165
|
+
const network = snapshotPrivateNetworkV1(networkValue);
|
|
166
|
+
return `${label(aliasValue)}.${network.networkDnsKey}.${network.organizationDnsKey}.${privateNetworkV1Contract.privateRoot}`;
|
|
167
|
+
});
|
|
168
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"privatenetwork.js","sourceRoot":"","sources":["../../ts/data/privatenetwork.ts"],"names":[],"mappings":"AAmEA,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,WAAW,EAAE,WAAW;IACxB,kBAAkB,EAAE,EAAE;IACtB,2BAA2B,EAAE,EAAE;IAC/B,gBAAgB,EAAE,CAAC;IACnB,wBAAwB,EAAE,EAAE;IAC5B,iBAAiB,EAAE,OAAO;IAC1B,yBAAyB,EAAE,CAAC;IAC5B,yBAAyB,EAAE,CAAC;IAC5B,uBAAuB,EAAE,2CAA2C;IACpE,QAAQ,EAAE,WAAW;CACb,CAAC,CAAC;AAEZ,MAAM,IAAI,GAAG,GAAU,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrF,SAAS,YAAY,CAAC,KAAc,IAAmB,IAAI,CAAC,KAAK;IAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5E,MAAM,IAAI,GAAG,CAAI,SAAkB,EAAK,EAAE,GAAG,IAAI,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;AAAC,CAAC;AAAC,MAAM,CAAC;IAAC,OAAO,IAAI,EAAE,CAAC;AAAC,CAAC,CAAC,CAAC,CAAC;AACpG,MAAM,MAAM,GAAG,CAAC,KAAc,EAAE,IAAc,EAA2B,EAAE;IACzE,YAAY,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACnF,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IACzG,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,YAAY,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvF,MAAM,MAAM,GAA4B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC/D,YAAY,CAAC,UAAU,EAAE,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AACF,MAAM,KAAK,GAAG,CAAI,KAAc,EAAE,OAAe,EAAE,IAA0B,EAAO,EAAE;IACpF,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,MAAM,IAAI,OAAO,CAAC,CAAC;IAClH,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACjE,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACzE,YAAY,CAAC,UAAU,EAAE,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AACF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAU,EAAE;IAC5C,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,qCAAqC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,OAAO,GAAG,CAAC,KAAc,EAAU,EAAE;IACzC,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACvH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,IAAI,GAAG,CAAC,KAAc,EAAU,EAAE;IACtC,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG;WAC5E,KAAK,KAAK,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,4CAA4C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,MAAM,GAAG,CAAC,KAAc,EAAE,MAAiB,EAAU,EAAE;IAC3D,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI,MAAM,CAAC,IAAI,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,KAAK,GAAG,CAAC,KAAc,EAAU,EAAE;IACvC,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE;WACvD,mCAAmC,CAAC,IAAI,CAAC,KAAK,CAAC;WAC/C,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACxF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,MAAM,GAAG,CAAC,MAAgB,EAAY,EAAE;IAC5C,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IACvF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AACF,MAAM,IAAI,GAAG,CAAC,KAAc,EAAU,EAAE;IACtC,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,YAAY,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACrH,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,KAAK,KAAK,iBAAiB,CAAC,CAAC;IAC5F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,YAAY,GAAG,CAAC,KAAc,EAAU,EAAE;IAC9C,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACtF,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7C,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE;WACpE,mCAAmC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;WAC/C,CAAC,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,oGAAoG;AACpG,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,KAAc,EAA2B,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACnG,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;IAC9D,YAAY,CAAC,MAAM,CAAC,YAAY,KAAK,kBAAkB,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,WAAW,KAAK,IAAI;QAAE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IAChG,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,oBAAoB,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACtG,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,gBAAgB,EAAE,KAAK,CAAC,EAAE;QAC7F,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,YAAY,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC;QAC5B,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3I,YAAY,CAAC,OAAO,QAAQ,CAAC,kBAAkB,KAAK,SAAS,CAAC,CAAC;IAC/D,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,iBAAiB,EAAE,wBAAwB,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC,CAAC;IACrI,YAAY,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC1G,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE;YACtD,SAAS,EAAE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,EAAE,iBAAiB;SAC9E,EAAE,CAAC;AACN,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,CAAC,gBAAyB,EAAE,YAAqB,EAAuE,EAAE;IAC3I,MAAM,WAAW,GAAG,KAAK,CAAC,gBAAgB,EAAE,wBAAwB,CAAC,kBAAkB,EAAE,KAAK,CAAC,EAAE;QAC/F,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;QAC3D,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAClD,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;IAC9G,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5D,MAAM,gBAAgB,GAAG,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACjF,YAAY,CAAC,gBAAgB,KAAK,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,KAAK,gBAAgB,CAAC,CAAC,CAAC;IACrH,YAAY,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,gBAAgB,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxF,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;AAC3C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAc,EAAqB,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACvF,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,eAAe,EAAE,IAAI,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,eAAe;QAC3G,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IACpE,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAe,CAAC,CAAC,CAAC;IACjH,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7C,YAAY,CAAC,SAAS,IAAI,SAAS,CAAC,CAAC;IACrC,OAAO,EAAE,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,cAAc,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC;QACvG,kBAAkB,EAAE,MAAM,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;QAC9G,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAmC;QACjH,MAAM,EAAE,8BAA8B,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;AACnF,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,KAAc,EAA6B,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACvG,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,eAAe,EAAE,gBAAgB,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC/H,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,CAAC,CAAC,CAAC;IAC1C,OAAO,EAAE,aAAa,EAAE,CAAC,EAAE,cAAc,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC;QACrH,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;AACxG,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,KAAc,EAAgC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IAC7G,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,eAAe,EAAE,gBAAgB,EAAE,WAAW,EAAE,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACrJ,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,CAAC,CAAC,CAAC;IAC1C,OAAO,EAAE,aAAa,EAAE,CAAC,EAAE,cAAc,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC;QACrH,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;QAC1I,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;AACnE,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,KAAc,EAA6B,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACvG,YAAY,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;IAC1D,MAAM,SAAS,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,KAAK,CAAC;IAC7E,YAAY,CAAC,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,QAAQ,CAAC,CAAC;IACzF,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB;QAC7G,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5G,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,CAAC,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,EAAE,aAAa,EAAE,CAAU,EAAE,cAAc,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;IAC3I,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,YAAY,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC;QAChD,OAAO,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,8BAA8B,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1I,CAAC;IACD,MAAM,OAAO,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAClH,IAAI,SAAS,KAAK,QAAQ;QAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC;IACtE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,8BAA8B,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AAC9H,CAAC,CAAC,CAAC;AAEH,8FAA8F;AAC9F,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,YAAqB,EAAE,UAAmB,EAAU,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACzG,MAAM,OAAO,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAC;IACvD,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,kBAAkB,IAAI,wBAAwB,CAAC,WAAW,EAAE,CAAC;AAC/H,CAAC,CAAC,CAAC"}
|
|
@@ -1,4 +1,66 @@
|
|
|
1
1
|
import * as plugins from '../plugins.js';
|
|
2
|
+
import type { IIdentityCredential } from '../data/user.js';
|
|
3
|
+
import type { IPrivateNetworkV1, IServicePrivateNetworksV1, ISetServicePrivateNetworksV1, TPrivateNetworkMutationV1 } from '../data/privatenetwork.js';
|
|
4
|
+
/** Every request is authorized against live canonical membership and Cloudly policy. */
|
|
5
|
+
export interface IReq_Cloudly_ListPrivateNetworksV1 extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_ListPrivateNetworksV1> {
|
|
6
|
+
method: 'listPrivateNetworksV1';
|
|
7
|
+
request: {
|
|
8
|
+
identity: IIdentityCredential;
|
|
9
|
+
organizationId: string;
|
|
10
|
+
cursor: string | null;
|
|
11
|
+
limit: number;
|
|
12
|
+
};
|
|
13
|
+
response: {
|
|
14
|
+
networks: IPrivateNetworkV1[];
|
|
15
|
+
nextCursor: string | null;
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
export interface IReq_Cloudly_GetPrivateNetworkV1 extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_GetPrivateNetworkV1> {
|
|
19
|
+
method: 'getPrivateNetworkV1';
|
|
20
|
+
request: {
|
|
21
|
+
identity: IIdentityCredential;
|
|
22
|
+
organizationId: string;
|
|
23
|
+
networkId: string;
|
|
24
|
+
};
|
|
25
|
+
response: {
|
|
26
|
+
network: IPrivateNetworkV1 | null;
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
export interface IReq_Cloudly_MutatePrivateNetworkV1 extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_MutatePrivateNetworkV1> {
|
|
30
|
+
method: 'mutatePrivateNetworkV1';
|
|
31
|
+
request: {
|
|
32
|
+
identity: IIdentityCredential;
|
|
33
|
+
mutation: TPrivateNetworkMutationV1;
|
|
34
|
+
};
|
|
35
|
+
/** Historical on replay; neither acceptance nor replay proves applied packet/DNS state. */
|
|
36
|
+
response: {
|
|
37
|
+
network: IPrivateNetworkV1;
|
|
38
|
+
replayed: boolean;
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export interface IReq_Cloudly_GetServicePrivateNetworksV1 extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_GetServicePrivateNetworksV1> {
|
|
42
|
+
method: 'getServicePrivateNetworksV1';
|
|
43
|
+
request: {
|
|
44
|
+
identity: IIdentityCredential;
|
|
45
|
+
organizationId: string;
|
|
46
|
+
serviceId: string;
|
|
47
|
+
};
|
|
48
|
+
response: {
|
|
49
|
+
membership: IServicePrivateNetworksV1 | null;
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
export interface IReq_Cloudly_SetServicePrivateNetworksV1 extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_SetServicePrivateNetworksV1> {
|
|
53
|
+
method: 'setServicePrivateNetworksV1';
|
|
54
|
+
request: {
|
|
55
|
+
identity: IIdentityCredential;
|
|
56
|
+
mutation: ISetServicePrivateNetworksV1;
|
|
57
|
+
};
|
|
58
|
+
/** Exact desired membership; enforcement and outstanding revocations remain separately observed. */
|
|
59
|
+
response: {
|
|
60
|
+
membership: IServicePrivateNetworksV1;
|
|
61
|
+
replayed: boolean;
|
|
62
|
+
};
|
|
63
|
+
}
|
|
2
64
|
export interface IRequest_Any_Cloudly_GetNetworkNodes {
|
|
3
65
|
method: 'getNetworkNodes';
|
|
4
66
|
request: {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@serve.zone/interfaces",
|
|
3
|
-
"version": "30.
|
|
3
|
+
"version": "30.3.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.",
|
|
6
6
|
"exports": {
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"@git.zone/tsbuild": "^4.4.2",
|
|
31
31
|
"@git.zone/tsdoc": "^2.2.0",
|
|
32
32
|
"@git.zone/tsrun": "^2.0.6",
|
|
33
|
-
"@git.zone/tstest": "^4.
|
|
33
|
+
"@git.zone/tstest": "^4.1.1",
|
|
34
34
|
"@types/node": "26.4.1"
|
|
35
35
|
},
|
|
36
36
|
"files": [
|
package/readme.md
CHANGED
|
@@ -192,6 +192,32 @@ delivery and the replay receipt must commit in the same authorized transaction.
|
|
|
192
192
|
The response contains only the immutable secret/version reference; no bearer or
|
|
193
193
|
hash is returned. Revocation removes current delivery from the metadata.
|
|
194
194
|
|
|
195
|
+
### Private Networks
|
|
196
|
+
|
|
197
|
+
`requests.network` defines organization-scoped network create/update/retire and
|
|
198
|
+
service attachment operations. Mutations require a retained idempotency ID and
|
|
199
|
+
an exact expected revision; `null` means no prior document. Cloudly must authorize
|
|
200
|
+
each request against live canonical membership and policy, reserve aliases
|
|
201
|
+
transactionally, reject cross-organization attachments, and retain historical
|
|
202
|
+
receipts. These contracts do not implement the backend or node enforcement.
|
|
203
|
+
|
|
204
|
+
`data.buildPrivateNetworkFqdnV1` produces
|
|
205
|
+
`<alias>.n-<26 lowercase base32 characters>.o-<26 lowercase base32 characters>.internal.`
|
|
206
|
+
from server-owned immutable DNS keys. Aliases are lowercase ASCII labels unique
|
|
207
|
+
per network. Display-name edits do not rename DNS. A sole attachment selects its
|
|
208
|
+
search suffix; several attachments require an explicit default or no search
|
|
209
|
+
suffix. Fully qualified names remain unambiguous across networks. Network policy
|
|
210
|
+
permits member-to-member connectivity and explicitly configures or denies external
|
|
211
|
+
DNS forwarding. Creating an alias does not publish public DNS, ingress or ports.
|
|
212
|
+
|
|
213
|
+
The snapshot helpers validate and detach content; they do not authenticate it,
|
|
214
|
+
reserve names, prove membership, or report applied state. Packet authority remains
|
|
215
|
+
until an applied denial or independent fence. DNS snapshots have a separate maximum
|
|
216
|
+
15-minute validity, with positive TTLs capped at five seconds and negative TTLs at
|
|
217
|
+
one second. DNS expiry does not prove packet revocation or permit identity reuse.
|
|
218
|
+
Retirement and attachment responses describe desired or historical metadata;
|
|
219
|
+
consumers must separately track outstanding node revocations and readiness.
|
|
220
|
+
|
|
195
221
|
### Node-Bound Runtime Assignments
|
|
196
222
|
|
|
197
223
|
The `data` namespace exports `IRuntimeAssignmentV1`, canonical digest helpers,
|
package/ts/00_commitinfo_data.ts
CHANGED
package/ts/data/index.ts
CHANGED
|
@@ -22,6 +22,7 @@ export * from './isolatedrestore.golden.js';
|
|
|
22
22
|
export * from './mail.js';
|
|
23
23
|
export * from './nodecredential.js';
|
|
24
24
|
export * from './nodeenrollment.js';
|
|
25
|
+
export * from './privatenetwork.js';
|
|
25
26
|
export * from './registry.js';
|
|
26
27
|
export * from './runtimeassignment.js';
|
|
27
28
|
export * from './runtimeconfig.js';
|
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
/** Cloudly owns these definitions. Membership never follows node placement. */
|
|
2
|
+
export interface IPrivateNetworkPolicyV1 {
|
|
3
|
+
connectivity: 'member-full-mesh';
|
|
4
|
+
/** null denies external resolution; private names are never forwarded. */
|
|
5
|
+
externalDns: {
|
|
6
|
+
upstreams: Array<{ address: string; port: number }>;
|
|
7
|
+
/** true requires an empty suffix list; false requires explicit suffixes. */
|
|
8
|
+
allowAnyPublicName: boolean;
|
|
9
|
+
permittedSuffixes: string[];
|
|
10
|
+
} | null;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export interface IPrivateNetworkV1 {
|
|
14
|
+
schemaVersion: 1;
|
|
15
|
+
id: string;
|
|
16
|
+
organizationId: string;
|
|
17
|
+
/** Immutable server-owned keys; display-name changes do not rename DNS. */
|
|
18
|
+
organizationDnsKey: string;
|
|
19
|
+
networkDnsKey: string;
|
|
20
|
+
name: string;
|
|
21
|
+
revision: number;
|
|
22
|
+
state: 'active' | 'retiring' | 'retired';
|
|
23
|
+
policy: IPrivateNetworkPolicyV1;
|
|
24
|
+
createdAt: number;
|
|
25
|
+
updatedAt: number;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface IPrivateNetworkAttachmentV1 {
|
|
29
|
+
networkId: string;
|
|
30
|
+
/** Sorted unique single-label aliases, reserved per network for this service. */
|
|
31
|
+
aliases: string[];
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Desired membership only. Acceptance is neither packet enforcement nor DNS readiness. */
|
|
35
|
+
export interface IServicePrivateNetworksV1 {
|
|
36
|
+
schemaVersion: 1;
|
|
37
|
+
organizationId: string;
|
|
38
|
+
serviceId: string;
|
|
39
|
+
revision: number;
|
|
40
|
+
/** Sorted by networkId; every network must have the same canonical organization. */
|
|
41
|
+
attachments: IPrivateNetworkAttachmentV1[];
|
|
42
|
+
/** Exactly the sole attachment, or explicit selection/null when several exist. */
|
|
43
|
+
defaultNetworkId: string | null;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
interface IPrivateNetworkMutationBaseV1 {
|
|
47
|
+
schemaVersion: 1;
|
|
48
|
+
organizationId: string;
|
|
49
|
+
/** Retain the exact body and this identifier across retries. */
|
|
50
|
+
mutationId: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export type TPrivateNetworkMutationV1 = IPrivateNetworkMutationBaseV1 & (
|
|
54
|
+
| { operation: 'create'; expectedRevision: null; name: string; policy: IPrivateNetworkPolicyV1 }
|
|
55
|
+
| { operation: 'update'; networkId: string; expectedRevision: number; name: string; policy: IPrivateNetworkPolicyV1 }
|
|
56
|
+
/** Retirement completes only after outstanding grants are denied or independently fenced. */
|
|
57
|
+
| { operation: 'retire'; networkId: string; expectedRevision: number }
|
|
58
|
+
);
|
|
59
|
+
|
|
60
|
+
export interface ISetServicePrivateNetworksV1 extends IPrivateNetworkMutationBaseV1 {
|
|
61
|
+
serviceId: string;
|
|
62
|
+
/** null means the service has never had a membership document; not an empty list. */
|
|
63
|
+
expectedRevision: number | null;
|
|
64
|
+
attachments: IPrivateNetworkAttachmentV1[];
|
|
65
|
+
defaultNetworkId: string | null;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export const privateNetworkV1Contract = Object.freeze({
|
|
69
|
+
privateRoot: 'internal.',
|
|
70
|
+
maximumAttachments: 16,
|
|
71
|
+
maximumAliasesPerAttachment: 32,
|
|
72
|
+
maximumUpstreams: 4,
|
|
73
|
+
maximumPermittedSuffixes: 64,
|
|
74
|
+
maximumDnsLeaseMs: 900_000,
|
|
75
|
+
maximumPositiveTtlSeconds: 5,
|
|
76
|
+
maximumNegativeTtlSeconds: 1,
|
|
77
|
+
packetAuthorityLifetime: 'until-applied-denial-or-independent-fence',
|
|
78
|
+
omission: 'no-effect',
|
|
79
|
+
} as const);
|
|
80
|
+
|
|
81
|
+
const fail = (): never => { throw new Error('Private network contract rejected.'); };
|
|
82
|
+
function requireValue(value: unknown): asserts value { if (!value) fail(); }
|
|
83
|
+
const safe = <T>(operation: () => T): T => { try { return operation(); } catch { return fail(); } };
|
|
84
|
+
const object = (value: unknown, keys: string[]): Record<string, unknown> => {
|
|
85
|
+
requireValue(value !== null && typeof value === 'object' && !Array.isArray(value));
|
|
86
|
+
requireValue(Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
|
|
87
|
+
const actual = Reflect.ownKeys(value);
|
|
88
|
+
requireValue(actual.length === keys.length && keys.every(key => actual.includes(key)));
|
|
89
|
+
const result: Record<string, unknown> = Object.create(null);
|
|
90
|
+
for (const key of keys) {
|
|
91
|
+
const descriptor = Object.getOwnPropertyDescriptor(value, key);
|
|
92
|
+
requireValue(descriptor?.enumerable && Object.hasOwn(descriptor, 'value'));
|
|
93
|
+
result[key] = descriptor.value;
|
|
94
|
+
}
|
|
95
|
+
return result;
|
|
96
|
+
};
|
|
97
|
+
const array = <T>(value: unknown, maximum: number, read: (item: unknown) => T): T[] => {
|
|
98
|
+
requireValue(Array.isArray(value) && Object.getPrototypeOf(value) === Array.prototype && value.length <= maximum);
|
|
99
|
+
requireValue(Reflect.ownKeys(value).length === value.length + 1);
|
|
100
|
+
const result: T[] = [];
|
|
101
|
+
for (let index = 0; index < value.length; index++) {
|
|
102
|
+
const descriptor = Object.getOwnPropertyDescriptor(value, String(index));
|
|
103
|
+
requireValue(descriptor?.enumerable && Object.hasOwn(descriptor, 'value'));
|
|
104
|
+
result.push(read(descriptor.value));
|
|
105
|
+
}
|
|
106
|
+
return result;
|
|
107
|
+
};
|
|
108
|
+
const identifier = (value: unknown): string => {
|
|
109
|
+
requireValue(typeof value === 'string' && /^[A-Za-z0-9][A-Za-z0-9:._-]{0,199}$/.test(value));
|
|
110
|
+
return value;
|
|
111
|
+
};
|
|
112
|
+
const counter = (value: unknown): number => {
|
|
113
|
+
requireValue(typeof value === 'number' && Number.isSafeInteger(value) && value > 0 && value < Number.MAX_SAFE_INTEGER);
|
|
114
|
+
return value;
|
|
115
|
+
};
|
|
116
|
+
const name = (value: unknown): string => {
|
|
117
|
+
requireValue(typeof value === 'string' && value.length > 0 && value.length <= 128
|
|
118
|
+
&& value === value.trim() && !/[\u0000-\u001f\u007f-\u009f\ud800-\udfff]/u.test(value));
|
|
119
|
+
return value;
|
|
120
|
+
};
|
|
121
|
+
const dnsKey = (value: unknown, prefix: 'o' | 'n'): string => {
|
|
122
|
+
requireValue(typeof value === 'string' && new RegExp(`^${prefix}-[a-z2-7]{26}$`).test(value));
|
|
123
|
+
return value;
|
|
124
|
+
};
|
|
125
|
+
const label = (value: unknown): string => {
|
|
126
|
+
requireValue(typeof value === 'string' && value.length <= 63
|
|
127
|
+
&& /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/.test(value)
|
|
128
|
+
&& !['localhost', 'internal', 'resolver', 'ns', 'ns1', 'hostmaster'].includes(value));
|
|
129
|
+
return value;
|
|
130
|
+
};
|
|
131
|
+
const sorted = (values: string[]): string[] => {
|
|
132
|
+
requireValue(values.every((value, index) => index === 0 || values[index - 1] < value));
|
|
133
|
+
return values;
|
|
134
|
+
};
|
|
135
|
+
const ipv4 = (value: unknown): string => {
|
|
136
|
+
requireValue(typeof value === 'string');
|
|
137
|
+
const parts = value.split('.');
|
|
138
|
+
requireValue(parts.length === 4 && parts.every(part => /^(?:0|[1-9][0-9]{0,2})$/.test(part) && Number(part) <= 255));
|
|
139
|
+
requireValue(Number(parts[0]) > 0 && Number(parts[0]) < 224 && value !== '255.255.255.255');
|
|
140
|
+
return value;
|
|
141
|
+
};
|
|
142
|
+
const publicSuffix = (value: unknown): string => {
|
|
143
|
+
requireValue(typeof value === 'string' && value.length <= 253 && value.endsWith('.'));
|
|
144
|
+
const labels = value.slice(0, -1).split('.');
|
|
145
|
+
requireValue(labels.length >= 2 && labels.every(part => part.length <= 63
|
|
146
|
+
&& /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/.test(part))
|
|
147
|
+
&& !['internal', 'localhost', 'local', 'arpa'].includes(labels[labels.length - 1]));
|
|
148
|
+
return value;
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
/** Structural validation only; backend IP ownership/reachability and policy fences are required. */
|
|
152
|
+
export const snapshotPrivateNetworkPolicyV1 = (value: unknown): IPrivateNetworkPolicyV1 => safe(() => {
|
|
153
|
+
const policy = object(value, ['connectivity', 'externalDns']);
|
|
154
|
+
requireValue(policy.connectivity === 'member-full-mesh');
|
|
155
|
+
if (policy.externalDns === null) return { connectivity: 'member-full-mesh', externalDns: null };
|
|
156
|
+
const external = object(policy.externalDns, ['upstreams', 'allowAnyPublicName', 'permittedSuffixes']);
|
|
157
|
+
const upstreams = array(external.upstreams, privateNetworkV1Contract.maximumUpstreams, entry => {
|
|
158
|
+
const upstream = object(entry, ['address', 'port']);
|
|
159
|
+
const port = counter(upstream.port);
|
|
160
|
+
requireValue(port <= 65535);
|
|
161
|
+
return { address: ipv4(upstream.address), port };
|
|
162
|
+
});
|
|
163
|
+
requireValue(upstreams.length > 0 && new Set(upstreams.map(upstream => `${upstream.address}:${upstream.port}`)).size === upstreams.length);
|
|
164
|
+
requireValue(typeof external.allowAnyPublicName === 'boolean');
|
|
165
|
+
const permittedSuffixes = sorted(array(external.permittedSuffixes, privateNetworkV1Contract.maximumPermittedSuffixes, publicSuffix));
|
|
166
|
+
requireValue(external.allowAnyPublicName ? permittedSuffixes.length === 0 : permittedSuffixes.length > 0);
|
|
167
|
+
return { connectivity: 'member-full-mesh', externalDns: {
|
|
168
|
+
upstreams, allowAnyPublicName: external.allowAnyPublicName, permittedSuffixes,
|
|
169
|
+
} };
|
|
170
|
+
});
|
|
171
|
+
|
|
172
|
+
const membership = (attachmentsValue: unknown, defaultValue: unknown): Pick<IServicePrivateNetworksV1, 'attachments' | 'defaultNetworkId'> => {
|
|
173
|
+
const attachments = array(attachmentsValue, privateNetworkV1Contract.maximumAttachments, entry => {
|
|
174
|
+
const attachment = object(entry, ['networkId', 'aliases']);
|
|
175
|
+
return { networkId: identifier(attachment.networkId),
|
|
176
|
+
aliases: sorted(array(attachment.aliases, privateNetworkV1Contract.maximumAliasesPerAttachment, label)) };
|
|
177
|
+
});
|
|
178
|
+
sorted(attachments.map(attachment => attachment.networkId));
|
|
179
|
+
const defaultNetworkId = defaultValue === null ? null : identifier(defaultValue);
|
|
180
|
+
requireValue(defaultNetworkId === null || attachments.some(attachment => attachment.networkId === defaultNetworkId));
|
|
181
|
+
requireValue(attachments.length !== 1 || defaultNetworkId === attachments[0].networkId);
|
|
182
|
+
return { attachments, defaultNetworkId };
|
|
183
|
+
};
|
|
184
|
+
|
|
185
|
+
export const snapshotPrivateNetworkV1 = (value: unknown): IPrivateNetworkV1 => safe(() => {
|
|
186
|
+
const network = object(value, ['schemaVersion', 'id', 'organizationId', 'organizationDnsKey', 'networkDnsKey',
|
|
187
|
+
'name', 'revision', 'state', 'policy', 'createdAt', 'updatedAt']);
|
|
188
|
+
requireValue(network.schemaVersion === 1 && ['active', 'retiring', 'retired'].includes(network.state as string));
|
|
189
|
+
const createdAt = counter(network.createdAt);
|
|
190
|
+
const updatedAt = counter(network.updatedAt);
|
|
191
|
+
requireValue(updatedAt >= createdAt);
|
|
192
|
+
return { schemaVersion: 1, id: identifier(network.id), organizationId: identifier(network.organizationId),
|
|
193
|
+
organizationDnsKey: dnsKey(network.organizationDnsKey, 'o'), networkDnsKey: dnsKey(network.networkDnsKey, 'n'),
|
|
194
|
+
name: name(network.name), revision: counter(network.revision), state: network.state as IPrivateNetworkV1['state'],
|
|
195
|
+
policy: snapshotPrivateNetworkPolicyV1(network.policy), createdAt, updatedAt };
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
export const snapshotServicePrivateNetworksV1 = (value: unknown): IServicePrivateNetworksV1 => safe(() => {
|
|
199
|
+
const service = object(value, ['schemaVersion', 'organizationId', 'serviceId', 'revision', 'attachments', 'defaultNetworkId']);
|
|
200
|
+
requireValue(service.schemaVersion === 1);
|
|
201
|
+
return { schemaVersion: 1, organizationId: identifier(service.organizationId), serviceId: identifier(service.serviceId),
|
|
202
|
+
revision: counter(service.revision), ...membership(service.attachments, service.defaultNetworkId) };
|
|
203
|
+
});
|
|
204
|
+
|
|
205
|
+
export const snapshotSetServicePrivateNetworksV1 = (value: unknown): ISetServicePrivateNetworksV1 => safe(() => {
|
|
206
|
+
const request = object(value, ['schemaVersion', 'organizationId', 'serviceId', 'mutationId', 'expectedRevision', 'attachments', 'defaultNetworkId']);
|
|
207
|
+
requireValue(request.schemaVersion === 1);
|
|
208
|
+
return { schemaVersion: 1, organizationId: identifier(request.organizationId), serviceId: identifier(request.serviceId),
|
|
209
|
+
mutationId: identifier(request.mutationId), expectedRevision: request.expectedRevision === null ? null : counter(request.expectedRevision),
|
|
210
|
+
...membership(request.attachments, request.defaultNetworkId) };
|
|
211
|
+
});
|
|
212
|
+
|
|
213
|
+
export const snapshotPrivateNetworkMutationV1 = (value: unknown): TPrivateNetworkMutationV1 => safe(() => {
|
|
214
|
+
requireValue(value !== null && typeof value === 'object');
|
|
215
|
+
const operation = Object.getOwnPropertyDescriptor(value, 'operation')?.value;
|
|
216
|
+
requireValue(operation === 'create' || operation === 'update' || operation === 'retire');
|
|
217
|
+
const request = object(value, ['schemaVersion', 'organizationId', 'mutationId', 'operation', 'expectedRevision',
|
|
218
|
+
...(operation === 'create' ? [] : ['networkId']), ...(operation === 'retire' ? [] : ['name', 'policy'])]);
|
|
219
|
+
requireValue(request.schemaVersion === 1);
|
|
220
|
+
const base = { schemaVersion: 1 as const, organizationId: identifier(request.organizationId), mutationId: identifier(request.mutationId) };
|
|
221
|
+
if (operation === 'create') {
|
|
222
|
+
requireValue(request.expectedRevision === null);
|
|
223
|
+
return { ...base, operation, expectedRevision: null, name: name(request.name), policy: snapshotPrivateNetworkPolicyV1(request.policy) };
|
|
224
|
+
}
|
|
225
|
+
const current = { networkId: identifier(request.networkId), expectedRevision: counter(request.expectedRevision) };
|
|
226
|
+
if (operation === 'retire') return { ...base, ...current, operation };
|
|
227
|
+
return { ...base, ...current, operation, name: name(request.name), policy: snapshotPrivateNetworkPolicyV1(request.policy) };
|
|
228
|
+
});
|
|
229
|
+
|
|
230
|
+
/** Pure naming helper; it does not reserve a name or create any public DNS/ingress record. */
|
|
231
|
+
export const buildPrivateNetworkFqdnV1 = (networkValue: unknown, aliasValue: unknown): string => safe(() => {
|
|
232
|
+
const network = snapshotPrivateNetworkV1(networkValue);
|
|
233
|
+
return `${label(aliasValue)}.${network.networkDnsKey}.${network.organizationDnsKey}.${privateNetworkV1Contract.privateRoot}`;
|
|
234
|
+
});
|
package/ts/requests/network.ts
CHANGED
|
@@ -1,4 +1,52 @@
|
|
|
1
1
|
import * as plugins from '../plugins.js';
|
|
2
|
+
import type { IIdentityCredential } from '../data/user.js';
|
|
3
|
+
import type {
|
|
4
|
+
IPrivateNetworkV1, IServicePrivateNetworksV1, ISetServicePrivateNetworksV1,
|
|
5
|
+
TPrivateNetworkMutationV1,
|
|
6
|
+
} from '../data/privatenetwork.js';
|
|
7
|
+
|
|
8
|
+
/** Every request is authorized against live canonical membership and Cloudly policy. */
|
|
9
|
+
export interface IReq_Cloudly_ListPrivateNetworksV1 extends plugins.typedrequestInterfaces.implementsTR<
|
|
10
|
+
plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_ListPrivateNetworksV1
|
|
11
|
+
> {
|
|
12
|
+
method: 'listPrivateNetworksV1';
|
|
13
|
+
request: { identity: IIdentityCredential; organizationId: string; cursor: string | null; limit: number };
|
|
14
|
+
response: { networks: IPrivateNetworkV1[]; nextCursor: string | null };
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface IReq_Cloudly_GetPrivateNetworkV1 extends plugins.typedrequestInterfaces.implementsTR<
|
|
18
|
+
plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_GetPrivateNetworkV1
|
|
19
|
+
> {
|
|
20
|
+
method: 'getPrivateNetworkV1';
|
|
21
|
+
request: { identity: IIdentityCredential; organizationId: string; networkId: string };
|
|
22
|
+
response: { network: IPrivateNetworkV1 | null };
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface IReq_Cloudly_MutatePrivateNetworkV1 extends plugins.typedrequestInterfaces.implementsTR<
|
|
26
|
+
plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_MutatePrivateNetworkV1
|
|
27
|
+
> {
|
|
28
|
+
method: 'mutatePrivateNetworkV1';
|
|
29
|
+
request: { identity: IIdentityCredential; mutation: TPrivateNetworkMutationV1 };
|
|
30
|
+
/** Historical on replay; neither acceptance nor replay proves applied packet/DNS state. */
|
|
31
|
+
response: { network: IPrivateNetworkV1; replayed: boolean };
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export interface IReq_Cloudly_GetServicePrivateNetworksV1 extends plugins.typedrequestInterfaces.implementsTR<
|
|
35
|
+
plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_GetServicePrivateNetworksV1
|
|
36
|
+
> {
|
|
37
|
+
method: 'getServicePrivateNetworksV1';
|
|
38
|
+
request: { identity: IIdentityCredential; organizationId: string; serviceId: string };
|
|
39
|
+
response: { membership: IServicePrivateNetworksV1 | null };
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface IReq_Cloudly_SetServicePrivateNetworksV1 extends plugins.typedrequestInterfaces.implementsTR<
|
|
43
|
+
plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_SetServicePrivateNetworksV1
|
|
44
|
+
> {
|
|
45
|
+
method: 'setServicePrivateNetworksV1';
|
|
46
|
+
request: { identity: IIdentityCredential; mutation: ISetServicePrivateNetworksV1 };
|
|
47
|
+
/** Exact desired membership; enforcement and outstanding revocations remain separately observed. */
|
|
48
|
+
response: { membership: IServicePrivateNetworksV1; replayed: boolean };
|
|
49
|
+
}
|
|
2
50
|
|
|
3
51
|
export interface IRequest_Any_Cloudly_GetNetworkNodes {
|
|
4
52
|
method: 'getNetworkNodes';
|