feat(api): complete phase 9 mobile contracts
This commit is contained in:
poyrazavsever
@@ -0,0 +1,171 @@
|
||||
import type { PublicBranding } from "../../branding/service";
|
||||
import type { InstanceIdentity } from "../../instance/service";
|
||||
|
||||
export const NETA_PROTOCOL = "neta" as const;
|
||||
export const NETA_DISCOVERY_VERSION = 1 as const;
|
||||
export const NETA_API_VERSION = "1" as const;
|
||||
export const NETA_API_BASE_PATH = "/api/v1" as const;
|
||||
|
||||
export type CapabilityStatus = "available" | "planned";
|
||||
export type CapabilityAccess = "public" | "session" | "freelancer" | "client";
|
||||
|
||||
export type NetaCapability = {
|
||||
id: string;
|
||||
version: number;
|
||||
status: CapabilityStatus;
|
||||
access: CapabilityAccess;
|
||||
};
|
||||
|
||||
export const NETA_CAPABILITIES = [
|
||||
{ id: "instance.discovery", version: 1, status: "available", access: "public" },
|
||||
{ id: "instance.branding", version: 1, status: "available", access: "public" },
|
||||
{ id: "auth.better-auth-cookie", version: 1, status: "available", access: "session" },
|
||||
{ id: "files.local", version: 1, status: "available", access: "session" },
|
||||
{ id: "freelancer.core", version: 1, status: "available", access: "freelancer" },
|
||||
{ id: "portal.client", version: 1, status: "available", access: "client" },
|
||||
{ id: "ai.assistant", version: 1, status: "available", access: "freelancer" },
|
||||
{ id: "auth.device-pairing", version: 1, status: "planned", access: "freelancer" },
|
||||
] as const satisfies readonly NetaCapability[];
|
||||
|
||||
export type NetaDiscoveryDocument = {
|
||||
protocol: typeof NETA_PROTOCOL;
|
||||
discoveryVersion: typeof NETA_DISCOVERY_VERSION;
|
||||
instanceId: string;
|
||||
applicationName: string;
|
||||
api: {
|
||||
version: typeof NETA_API_VERSION;
|
||||
baseUrl: string;
|
||||
metaUrl: string;
|
||||
healthUrl: string;
|
||||
};
|
||||
security: {
|
||||
httpsRequired: true;
|
||||
insecureLoopbackAllowed: true;
|
||||
};
|
||||
};
|
||||
|
||||
export type NetaInstanceMetadata = {
|
||||
protocol: {
|
||||
name: typeof NETA_PROTOCOL;
|
||||
discoveryVersion: typeof NETA_DISCOVERY_VERSION;
|
||||
apiVersion: typeof NETA_API_VERSION;
|
||||
};
|
||||
server: {
|
||||
version: string;
|
||||
};
|
||||
instance: {
|
||||
id: string;
|
||||
createdAt: string;
|
||||
applicationName: string;
|
||||
shortName: string;
|
||||
organizationName: string | null;
|
||||
};
|
||||
branding: {
|
||||
primaryColor: string;
|
||||
accentColor: string;
|
||||
defaultColorMode: PublicBranding["defaultColorMode"];
|
||||
radiusScale: PublicBranding["radiusScale"];
|
||||
lightLogoUrl: string | null;
|
||||
darkLogoUrl: string | null;
|
||||
iconUrl: string | null;
|
||||
};
|
||||
client: {
|
||||
minimumSupportedVersion: string | null;
|
||||
platforms: readonly ["ios", "android"];
|
||||
};
|
||||
authentication: {
|
||||
sessionMethod: "better-auth-cookie";
|
||||
devicePairing: "planned";
|
||||
};
|
||||
capabilities: readonly NetaCapability[];
|
||||
links: {
|
||||
discovery: string;
|
||||
apiBase: string;
|
||||
health: string;
|
||||
me: string;
|
||||
};
|
||||
};
|
||||
|
||||
type ContractInput = {
|
||||
appUrl: string;
|
||||
serverVersion: string;
|
||||
minimumMobileClientVersion: string | null;
|
||||
identity: InstanceIdentity;
|
||||
branding: PublicBranding;
|
||||
};
|
||||
|
||||
export function buildDiscoveryDocument(
|
||||
input: ContractInput,
|
||||
): NetaDiscoveryDocument {
|
||||
const apiBaseUrl = absoluteUrl(input.appUrl, NETA_API_BASE_PATH);
|
||||
return {
|
||||
protocol: NETA_PROTOCOL,
|
||||
discoveryVersion: NETA_DISCOVERY_VERSION,
|
||||
instanceId: input.identity.instanceId,
|
||||
applicationName: input.branding.applicationName,
|
||||
api: {
|
||||
version: NETA_API_VERSION,
|
||||
baseUrl: apiBaseUrl,
|
||||
metaUrl: absoluteUrl(input.appUrl, `${NETA_API_BASE_PATH}/meta`),
|
||||
healthUrl: absoluteUrl(input.appUrl, `${NETA_API_BASE_PATH}/health`),
|
||||
},
|
||||
security: {
|
||||
httpsRequired: true,
|
||||
insecureLoopbackAllowed: true,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function buildInstanceMetadata(
|
||||
input: ContractInput,
|
||||
): NetaInstanceMetadata {
|
||||
return {
|
||||
protocol: {
|
||||
name: NETA_PROTOCOL,
|
||||
discoveryVersion: NETA_DISCOVERY_VERSION,
|
||||
apiVersion: NETA_API_VERSION,
|
||||
},
|
||||
server: {
|
||||
version: input.serverVersion,
|
||||
},
|
||||
instance: {
|
||||
id: input.identity.instanceId,
|
||||
createdAt: input.identity.createdAt,
|
||||
applicationName: input.branding.applicationName,
|
||||
shortName: input.branding.shortName,
|
||||
organizationName: input.branding.organizationName,
|
||||
},
|
||||
branding: {
|
||||
primaryColor: input.branding.primaryColor,
|
||||
accentColor: input.branding.accentColor,
|
||||
defaultColorMode: input.branding.defaultColorMode,
|
||||
radiusScale: input.branding.radiusScale,
|
||||
lightLogoUrl: absoluteOptionalUrl(input.appUrl, input.branding.lightLogoUrl),
|
||||
darkLogoUrl: absoluteOptionalUrl(input.appUrl, input.branding.darkLogoUrl),
|
||||
iconUrl: absoluteOptionalUrl(input.appUrl, input.branding.iconUrl),
|
||||
},
|
||||
client: {
|
||||
minimumSupportedVersion: input.minimumMobileClientVersion,
|
||||
platforms: ["ios", "android"],
|
||||
},
|
||||
authentication: {
|
||||
sessionMethod: "better-auth-cookie",
|
||||
devicePairing: "planned",
|
||||
},
|
||||
capabilities: NETA_CAPABILITIES,
|
||||
links: {
|
||||
discovery: absoluteUrl(input.appUrl, "/.well-known/neta"),
|
||||
apiBase: absoluteUrl(input.appUrl, NETA_API_BASE_PATH),
|
||||
health: absoluteUrl(input.appUrl, `${NETA_API_BASE_PATH}/health`),
|
||||
me: absoluteUrl(input.appUrl, `${NETA_API_BASE_PATH}/me`),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function absoluteOptionalUrl(baseUrl: string, value: string | null): string | null {
|
||||
return value ? absoluteUrl(baseUrl, value) : null;
|
||||
}
|
||||
|
||||
function absoluteUrl(baseUrl: string, pathname: string): string {
|
||||
return new URL(pathname, `${baseUrl}/`).toString();
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
import "server-only";
|
||||
|
||||
import type { NextResponse } from "next/server";
|
||||
import { apiError, apiSuccess } from "../responses";
|
||||
import { NETA_API_VERSION } from "./contracts";
|
||||
|
||||
export function apiV1Success<T>(
|
||||
data: T,
|
||||
init?: ResponseInit,
|
||||
): NextResponse {
|
||||
return withV1Headers(apiSuccess(data, init));
|
||||
}
|
||||
|
||||
export function apiV1Error(error: unknown): NextResponse {
|
||||
return withV1Headers(apiError(error));
|
||||
}
|
||||
|
||||
function withV1Headers(response: NextResponse): NextResponse {
|
||||
response.headers.set("X-Neta-API-Version", NETA_API_VERSION);
|
||||
if (!response.headers.has("Cache-Control")) {
|
||||
response.headers.set("Cache-Control", "private, no-store");
|
||||
}
|
||||
return response;
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
import "server-only";
|
||||
|
||||
import packageJson from "../../../package.json";
|
||||
import { getPublicBranding } from "../../branding/runtime";
|
||||
import { getServerConfig } from "../../config";
|
||||
import { getInstanceService } from "../../instance/runtime";
|
||||
import {
|
||||
buildDiscoveryDocument,
|
||||
buildInstanceMetadata,
|
||||
} from "./contracts";
|
||||
|
||||
export function getNetaDiscoveryDocument() {
|
||||
return buildDiscoveryDocument(getContractInput());
|
||||
}
|
||||
|
||||
export function getNetaInstanceMetadata() {
|
||||
return buildInstanceMetadata(getContractInput());
|
||||
}
|
||||
|
||||
function getContractInput() {
|
||||
const config = getServerConfig();
|
||||
return {
|
||||
appUrl: config.appUrl,
|
||||
serverVersion: packageJson.version,
|
||||
minimumMobileClientVersion: config.minimumMobileClientVersion,
|
||||
identity: getInstanceService().getIdentity(),
|
||||
branding: getPublicBranding(),
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user