@dcl/protocol 1.0.0-4959770633.commit-e249449 → 1.0.0-4982452399.commit-2113622

package/README.md

@@ -20,21 +20,39 @@ protoc \
 ```
 
 # Style Guidelines
+
 1. All .proto files are snake_case.proto.
 2. For pascal or camel case usage, please make a deterministic one from the snake case. Example: nft_shape will transform to NftShape.
 3. See https://docs.buf.build/best-practices/style-guide. The most of other styles are taken from there, the Buf configuration is in proto/buf.yml.
 4. Use public/ folder only for .proto with protocol exposing, that is only for files with `import public`. This folder is not processed by the linter.
 
 # Dev with Decentraland Repositories
+
 Many repositories depend on this protocol definition and that sometimes implies some merge order. We don't have to worry much about compatibility because the checks are running with each PR, if you break something, the CI will warn you. But, in some cases, it's desirable to merge the implementation in a specific order to avoid unexpected behavior in the corner cases (multiple repositories are waiting for the build at the same time).
 
+> **Important Note: Avoid Merging Protocol PR Without Completed Unity Implementation**
+>
+> Please don't merge a protocol PR into the main branch unless the corresponding implementation in Unity has been completed. This is important to avoid any potential issues or build failures in Unity.
+>
+> The ideal order for introducing breaking changes in the protocol is as follows:
+>
+> 1. Create a PR in the Protocol repository.
+> 2. Use the npm test link from the CI of the protocol PR in the protocol-dependent application for development.
+> 3. Once both the protocol PR and the protocol-dependent application (e.g. unity-renderer) PR are ready for merging, synchronize their merging as follows:
+>    1. Merge the protocol PR.
+>    2. Modify protocol-dependent application PR to use the `@dcl/protocol@next` package to stop using the PR npm test link.
+>    3. Merge the protocol-dependent application PR.
+
 Some dev-cases are described here:
-## SDK: New component or component modification 
+
+## SDK: New component or component modification
+
 Repositories: [unity-renderer](https://github.com/decentraland/unity-renderer/) and [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/)
 
 At the protocol level both operations shouldn't be a problem, but `js-sdk-toolchain` CI will fail if the component is not tested. This can happen if the PR **`A`** from the protocol is merged, and you update your PR **`B`** from `js-sdk-toolchain` with the changes before the PR **`A`** from `js-sdk-toolchain` is merged.
 
 Some guidelines and testing before merge:
+
 - The protocol package is uploaded to S3 while developing in a PR. This can be used in the target repositories
 - Testing in the playground: Playground allows us to test by adding query parameters: `https://playground.decentraland.org/?&renderer-branch=**feat/my-new-component**&sdk-branch=**feat/new-component-approach**`
 - Testing locally: you can write an example scene and install the package `@dcl/sdk` uploaded to S3 commented in the PR comments.
@@ -42,16 +60,20 @@ Some guidelines and testing before merge:
 - Start merging when the three PRs are already to merge: first merge the Protocol one, then update the other two with the version @next and merge them at the same time.
 
 ## SDK: New APIs or APIs modifications
-Repositories: [kernel](https://github.com/decentraland/kernel/), [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/) and [scene-runtime](https://github.com/decentraland/scene-runtime/) 
+
+Repositories: [kernel](https://github.com/decentraland/kernel/), [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/) and [scene-runtime](https://github.com/decentraland/scene-runtime/)
 In this case, there is no problem with when each PR is merged. It's recommendable to merge first the rpc server-side (in this case, Kernel), second the `scene-runtime` (and this would require a second update from `kernel`) and last the `js-sdk-toolchain`.
 
 ## Renderer protocol (RPC)
+
 Repositories: [kernel](https://github.com/decentraland/kernel/) and [unity-renderer](https://github.com/decentraland/unity-renderer/)
 
 TODO
 
 ## BFF
+
 TODO
 
-## Comms 
+## Comms
+
 TODO

package/out-js/decentraland/social/friendships/friendships.gen.d.ts

@@ -1,5 +1,18 @@
 import _m0 from "protobufjs/minimal";
 export declare const protobufPackage = "decentraland.social.friendships";
+export declare enum ServiceErrors {
+    /** UNKNOWN - proto3 requires that first value in enum have numeric value of 0 */
+    UNKNOWN = 0,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    UNRECOGNIZED = -1
+}
+export declare function serviceErrorsFromJSON(object: any): ServiceErrors;
+export declare function serviceErrorsToJSON(object: ServiceErrors): string;
 /** This message is a response that is sent from the server to the client */
 export interface FriendshipEventResponse {
     body?: {
@@ -19,9 +32,6 @@ export interface FriendshipEventResponse {
         cancel: CancelResponse;
     };
 }
-export interface FriendshipEventResponses {
-    responses: FriendshipEventResponse[];
-}
 export interface FriendshipEventPayload {
     body?: {
         $case: "request";
@@ -95,99 +105,15 @@ export interface UpdateFriendshipPayload {
     /** For internal use only, subject to change. */
     authToken?: Payload | undefined;
 }
-export interface Payload {
-    /** For internal use only, subject to change. */
-    synapseToken?: string | undefined;
-}
-export interface BadRequestError {
-    message: string;
-}
-export interface UnauthorizedError {
-    message: string;
-}
-export interface ForbiddenError {
-    message: string;
-}
-export interface TooManyRequestsError {
-    message: string;
-}
-export interface InternalServerError {
-    message: string;
-}
-export interface UsersResponse {
-    response?: {
-        $case: "users";
-        users: Users;
-    } | {
-        $case: "internalServerError";
-        internalServerError: InternalServerError;
-    } | {
-        $case: "unauthorizedError";
-        unauthorizedError: UnauthorizedError;
-    } | {
-        $case: "forbiddenError";
-        forbiddenError: ForbiddenError;
-    } | {
-        $case: "tooManyRequestsError";
-        tooManyRequestsError: TooManyRequestsError;
-    };
-}
-export interface RequestEventsResponse {
-    response?: {
-        $case: "events";
-        events: RequestEvents;
-    } | {
-        $case: "internalServerError";
-        internalServerError: InternalServerError;
-    } | {
-        $case: "unauthorizedError";
-        unauthorizedError: UnauthorizedError;
-    } | {
-        $case: "forbiddenError";
-        forbiddenError: ForbiddenError;
-    } | {
-        $case: "tooManyRequestsError";
-        tooManyRequestsError: TooManyRequestsError;
-    };
-}
 export interface UpdateFriendshipResponse {
-    response?: {
-        $case: "event";
-        event: FriendshipEventResponse;
-    } | {
-        $case: "internalServerError";
-        internalServerError: InternalServerError;
-    } | {
-        $case: "unauthorizedError";
-        unauthorizedError: UnauthorizedError;
-    } | {
-        $case: "forbiddenError";
-        forbiddenError: ForbiddenError;
-    } | {
-        $case: "tooManyRequestsError";
-        tooManyRequestsError: TooManyRequestsError;
-    } | {
-        $case: "badRequestError";
-        badRequestError: BadRequestError;
-    };
+    event: FriendshipEventResponse | undefined;
 }
 export interface SubscribeFriendshipEventsUpdatesResponse {
-    response?: {
-        $case: "events";
-        events: FriendshipEventResponses;
-    } | {
-        $case: "internalServerError";
-        internalServerError: InternalServerError;
-    } | {
-        $case: "unauthorizedError";
-        unauthorizedError: UnauthorizedError;
-    } | {
-        $case: "forbiddenError";
-        forbiddenError: ForbiddenError;
-    } | {
-        $case: "tooManyRequestsError";
-        tooManyRequestsError: TooManyRequestsError;
-    };
+    events: FriendshipEventResponse[];
+}
+export interface Payload {
+    /** For internal use only, subject to change. */
+    synapseToken?: string | undefined;
 }
 export declare namespace FriendshipEventResponse {
     function encode(message: FriendshipEventResponse, writer?: _m0.Writer): _m0.Writer;
@@ -197,14 +123,6 @@ export declare namespace FriendshipEventResponse {
     function create<I extends Exact<DeepPartial<FriendshipEventResponse>, I>>(base?: I): FriendshipEventResponse;
     function fromPartial<I extends Exact<DeepPartial<FriendshipEventResponse>, I>>(object: I): FriendshipEventResponse;
 }
-export declare namespace FriendshipEventResponses {
-    function encode(message: FriendshipEventResponses, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): FriendshipEventResponses;
-    function fromJSON(object: any): FriendshipEventResponses;
-    function toJSON(message: FriendshipEventResponses): unknown;
-    function create<I extends Exact<DeepPartial<FriendshipEventResponses>, I>>(base?: I): FriendshipEventResponses;
-    function fromPartial<I extends Exact<DeepPartial<FriendshipEventResponses>, I>>(object: I): FriendshipEventResponses;
-}
 export declare namespace FriendshipEventPayload {
     function encode(message: FriendshipEventPayload, writer?: _m0.Writer): _m0.Writer;
     function decode(input: _m0.Reader | Uint8Array, length?: number): FriendshipEventPayload;
@@ -333,70 +251,6 @@ export declare namespace UpdateFriendshipPayload {
     function create<I extends Exact<DeepPartial<UpdateFriendshipPayload>, I>>(base?: I): UpdateFriendshipPayload;
     function fromPartial<I extends Exact<DeepPartial<UpdateFriendshipPayload>, I>>(object: I): UpdateFriendshipPayload;
 }
-export declare namespace Payload {
-    function encode(message: Payload, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): Payload;
-    function fromJSON(object: any): Payload;
-    function toJSON(message: Payload): unknown;
-    function create<I extends Exact<DeepPartial<Payload>, I>>(base?: I): Payload;
-    function fromPartial<I extends Exact<DeepPartial<Payload>, I>>(object: I): Payload;
-}
-export declare namespace BadRequestError {
-    function encode(message: BadRequestError, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): BadRequestError;
-    function fromJSON(object: any): BadRequestError;
-    function toJSON(message: BadRequestError): unknown;
-    function create<I extends Exact<DeepPartial<BadRequestError>, I>>(base?: I): BadRequestError;
-    function fromPartial<I extends Exact<DeepPartial<BadRequestError>, I>>(object: I): BadRequestError;
-}
-export declare namespace UnauthorizedError {
-    function encode(message: UnauthorizedError, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): UnauthorizedError;
-    function fromJSON(object: any): UnauthorizedError;
-    function toJSON(message: UnauthorizedError): unknown;
-    function create<I extends Exact<DeepPartial<UnauthorizedError>, I>>(base?: I): UnauthorizedError;
-    function fromPartial<I extends Exact<DeepPartial<UnauthorizedError>, I>>(object: I): UnauthorizedError;
-}
-export declare namespace ForbiddenError {
-    function encode(message: ForbiddenError, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): ForbiddenError;
-    function fromJSON(object: any): ForbiddenError;
-    function toJSON(message: ForbiddenError): unknown;
-    function create<I extends Exact<DeepPartial<ForbiddenError>, I>>(base?: I): ForbiddenError;
-    function fromPartial<I extends Exact<DeepPartial<ForbiddenError>, I>>(object: I): ForbiddenError;
-}
-export declare namespace TooManyRequestsError {
-    function encode(message: TooManyRequestsError, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): TooManyRequestsError;
-    function fromJSON(object: any): TooManyRequestsError;
-    function toJSON(message: TooManyRequestsError): unknown;
-    function create<I extends Exact<DeepPartial<TooManyRequestsError>, I>>(base?: I): TooManyRequestsError;
-    function fromPartial<I extends Exact<DeepPartial<TooManyRequestsError>, I>>(object: I): TooManyRequestsError;
-}
-export declare namespace InternalServerError {
-    function encode(message: InternalServerError, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): InternalServerError;
-    function fromJSON(object: any): InternalServerError;
-    function toJSON(message: InternalServerError): unknown;
-    function create<I extends Exact<DeepPartial<InternalServerError>, I>>(base?: I): InternalServerError;
-    function fromPartial<I extends Exact<DeepPartial<InternalServerError>, I>>(object: I): InternalServerError;
-}
-export declare namespace UsersResponse {
-    function encode(message: UsersResponse, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): UsersResponse;
-    function fromJSON(object: any): UsersResponse;
-    function toJSON(message: UsersResponse): unknown;
-    function create<I extends Exact<DeepPartial<UsersResponse>, I>>(base?: I): UsersResponse;
-    function fromPartial<I extends Exact<DeepPartial<UsersResponse>, I>>(object: I): UsersResponse;
-}
-export declare namespace RequestEventsResponse {
-    function encode(message: RequestEventsResponse, writer?: _m0.Writer): _m0.Writer;
-    function decode(input: _m0.Reader | Uint8Array, length?: number): RequestEventsResponse;
-    function fromJSON(object: any): RequestEventsResponse;
-    function toJSON(message: RequestEventsResponse): unknown;
-    function create<I extends Exact<DeepPartial<RequestEventsResponse>, I>>(base?: I): RequestEventsResponse;
-    function fromPartial<I extends Exact<DeepPartial<RequestEventsResponse>, I>>(object: I): RequestEventsResponse;
-}
 export declare namespace UpdateFriendshipResponse {
     function encode(message: UpdateFriendshipResponse, writer?: _m0.Writer): _m0.Writer;
     function decode(input: _m0.Reader | Uint8Array, length?: number): UpdateFriendshipResponse;
@@ -413,6 +267,14 @@ export declare namespace SubscribeFriendshipEventsUpdatesResponse {
     function create<I extends Exact<DeepPartial<SubscribeFriendshipEventsUpdatesResponse>, I>>(base?: I): SubscribeFriendshipEventsUpdatesResponse;
     function fromPartial<I extends Exact<DeepPartial<SubscribeFriendshipEventsUpdatesResponse>, I>>(object: I): SubscribeFriendshipEventsUpdatesResponse;
 }
+export declare namespace Payload {
+    function encode(message: Payload, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): Payload;
+    function fromJSON(object: any): Payload;
+    function toJSON(message: Payload): unknown;
+    function create<I extends Exact<DeepPartial<Payload>, I>>(base?: I): Payload;
+    function fromPartial<I extends Exact<DeepPartial<Payload>, I>>(object: I): Payload;
+}
 export type FriendshipsServiceDefinition = typeof FriendshipsServiceDefinition;
 export declare const FriendshipsServiceDefinition: {
     readonly name: "FriendshipsService";
@@ -423,7 +285,7 @@ export declare const FriendshipsServiceDefinition: {
             readonly name: "GetFriends";
             readonly requestType: typeof Payload;
             readonly requestStream: false;
-            readonly responseType: typeof UsersResponse;
+            readonly responseType: typeof Users;
             readonly responseStream: true;
             readonly options: {};
         };
@@ -432,7 +294,7 @@ export declare const FriendshipsServiceDefinition: {
             readonly name: "GetRequestEvents";
             readonly requestType: typeof Payload;
             readonly requestStream: false;
-            readonly responseType: typeof RequestEventsResponse;
+            readonly responseType: typeof RequestEvents;
             readonly responseStream: false;
             readonly options: {};
         };
@@ -445,7 +307,10 @@ export declare const FriendshipsServiceDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
-        /** Subscribe to updates of friendship status: REQUEST, ACCEPT, REJECT, CANCEL, DELETE */
+        /**
+         * Subscribe to updates of friendship status: REQUEST, ACCEPT, REJECT, CANCEL,
+         * DELETE
+         */
         readonly subscribeFriendshipEventsUpdates: {
             readonly name: "SubscribeFriendshipEventsUpdates";
             readonly requestType: typeof Payload;